LOC-18 Deploy server with ansible
[LocalChat.git] / client / LocalChatClient.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
#!/usr/bin/env python
#
#
# Interface based upon https://github.com/izderadicka/xmpp-tester/blob/master/commander.py
#
# apt-get install:
#     python-urwid
#     python-gnupg
 
 
import urwid
from collections import deque
from threading import Thread
import threading
 
import json
import urllib2
import ssl
import string
import random
import sys
import datetime as dt
 
import gnupg
 
 
 
# This can be changed from the commandline
SERVER='https://127.0.0.1:8090'
 
class msgHandler(object):
    
    def __init__(self):
        self.last = 0
        self.user = False
        self.server = SERVER
        self.room = False
        self.roompass = False
        self.sesskey = False
        self.syskey = False
        self.verifycert = False
        self.gpg = gnupg.GPG()
    
    
    def pollForMessage(self):
        
        if not self.room:
            # We're not connected to a room
            return False
        
        
        payload = {"roomName": self.room, 
                   "mylast":self.last,
                   "user": self.user,
                   "sesskey": self.sesskey
                   }
        
        request = {"action":"pollMsg",
                   "payload": json.dumps(payload)
                   }
 
        resp = self.sendRequest(request)
        
        if resp == "BROKENLINK":
            return resp
        
        
        if resp['status'] == "unchanged":
            return False
        
        
        if resp['status'] == "errmessage":
            # Got an error, we need to stop the poll and then return the text
            self.room = False
            self.roompass = False
            self.sesskey = False
            return [['reversed',resp['text']]]
        
        to_print = []
        # Otherwise, process the messages
        for i in resp["messages"]:
            self.last = i[0]
            upstruser = i[3]
            
            try:
                msgbody = json.loads(self.decrypt(i[1],upstruser))
            except:
                # Means an invalid message was received - LOC-8
                to_print.append(['error','Received message which could not be decrypted'])
                continue
            
            # TODO - We'll need to json decode and extract the sending user's name
            # but not currently including that info in my curl tests. Also means test that part of the next block
            
            color = "green"
 
            if upstruser == self.user:
                # One of our own, change the color
                color = "blue"
            
            elif upstruser == "SYSTEM":
                color = "magenta"
                if msgbody['verb'] == "sysalert":
                    color = 'reversed'
                elif msgbody['verb'] == 'syswarn':
                    color = 'cyan'
                
            
            ts = dt.datetime.utcfromtimestamp(i[2]).strftime("[%H:%M:%S]")
            
            if msgbody["verb"] == "do":
                color = 'yellow'
                line = [
                    "        ** %s %s **" % (upstruser,msgbody['text'])
                    ]
            else:
                
                if i[4] != "0":
                    color = 'brown'
                    upstruser = 'DM %s' % (upstruser,)
                
                line = [
                    ts, # timestamp
                    "%s>" % (upstruser,), # To be replaced later
                    msgbody['text']
                    ]
            
            to_print.append([color,' '.join(line)])
        
        return to_print
        
        
    def sendMsg(self,line,verb='say'):
        ''' Send a message 
        '''
        
        if not self.room:
            # We're not in a room. Abort
            return False
        
        # Otherwise, build a payload
        
        
        msg = {
            'user': self.user,
            'text': line,
            "verb": verb
            }
        
        payload = {"roomName": self.room, 
                   "msg":self.encrypt(json.dumps(msg)),
                   "user": self.user,
                   "sesskey": self.sesskey
                   }
        
        request = {"action":"sendMsg",
                   "payload": json.dumps(payload)
                   }
 
        resp = self.sendRequest(request)        
        
        if "status" in resp and resp['status'] == "ok":
            return True
        
        return False
        
 
 
    def sendDirectMsg(self,line,user,verb='say'):
        ''' Send a direct message
        '''
        
        if not self.room:
            # We're not in a room. Abort
            return False
        
        # Otherwise, build a payload
        
        msg = {
            'user': self.user,
            'text': line,
            "verb": verb
            }
        
        payload = {"roomName": self.room, 
                   "msg":self.encrypt(json.dumps(msg)), # TODO this should use the user's key
                   "to": user,
                   "user": self.user,
                   "sesskey": self.sesskey
                   }
        
        request = {"action":"sendDirectMsg",
                   "payload": json.dumps(payload)
                   }
 
        resp = self.sendRequest(request)        
        
        if "status" in resp and resp['status'] == "ok":
            return True
        
        return False
 
 
 
 
    def joinRoom(self,user,room,passw):
        ''' Join a room
        '''
        
        # We only want to send the user password section of the password
        p = passw.split(":")
        userpass = p[1]
        
        payload = {"roomName": room, 
                   "userpass": userpass.encode('utf-8'),
                   "user": user
                   }
        
        request = {"action":"joinRoom",
                   "payload": json.dumps(payload)
                   }        
 
 
        resp = self.sendRequest(request)
 
        if resp == "BROKENLINK" or resp['status'] != "ok":
            return False
        
        
        self.room = room
        self.user = user
        self.last = resp['last']
        self.roompass = p[0] # The room password is the first section of the password
        self.sesskey = resp['session']
        self.syskey = resp['syskey']
        return True
 
 
 
 
    def leaveRoom(self):
        ''' Leave the current room
        '''
        if not self.room:
            return False
        
        payload = {"roomName": self.room, 
                   "user": self.user,
                   "sesskey": self.sesskey
                   }
        
        request = {"action":"leaveRoom",
                   "payload": json.dumps(payload)
                   }        
 
 
        resp = self.sendRequest(request)
 
        if resp == "BROKENLINK" or resp['status'] != "ok":
            return False
        
        self.room = False
        self.user = False
        self.last = 0
        self.roompass = False
        self.sesskey = False
        
        return True
                
 
 
    def createRoom(self,room,user=False):
        ''' Create a new room
        '''
        
        if not user and not self.user:
            return False
        
        if not user:
            user = self.user
 
 
        # Generate a password for the admin
        passw = self.genpassw()
                
        payload = {"roomName": room, 
                   "owner": user,
                   "pass": passw
                   }
        
        request = {"action":"createRoom",
                   "payload": json.dumps(payload)
                   }        
        
        resp = self.sendRequest(request)
 
        if resp == "BROKENLINK" or resp['status'] != "ok":
            return False
        
        return [resp['name'],passw]
    
 
    def closeRoom(self):
        if not self.room:
            return False
 
        payload = {"roomName": self.room, 
                   "user": self.user,
                   "sesskey": self.sesskey
                   }
        
        request = {"action":"closeRoom",
                   "payload": json.dumps(payload)
                   }        
 
        resp = self.sendRequest(request)
        if resp == "BROKENLINK" or resp['status'] != "ok":
            return False
        
        return True
        
        
 
    def inviteUser(self,user):
        ''' Invite a user into a room
        
        #TODO - Authentication
        '''
        
        
        # Generate a password for the new user
        passw = self.genpassw()
        
        payload = {"roomName": self.room, 
                   "user": self.user,
                   "invite": user,
                   "pass": passw,
                   "sesskey": self.sesskey
                   }
        
        request = {"action":"inviteUser",
                   "payload": json.dumps(payload)
                   }    
        
        resp = self.sendRequest(request)
 
        if resp == "BROKENLINK" or resp['status'] != "ok":
            return False
        
        return [self.room,self.roompass,passw,user]
 
 
 
    def kickUser(self,user,ban=False):
        ''' Kick a user out of the room
        '''
        
        action = 'banUser'
        
        if not ban:
            action = 'kickUser'
        
        payload = {"roomName": self.room, 
                   "user": self.user,
                   "kick": user,
                   "sesskey": self.sesskey
                   }
        
        request = {"action":action,
                   "payload": json.dumps(payload)
                   }    
                
        resp = self.sendRequest(request)
 
        if resp == "BROKENLINK" or resp['status'] != "ok":
            return False
        
        return True
 
        
        
 
    def sendRequest(self,data):
        data = json.dumps(data)
        
        try:
            
            ctx = ssl.create_default_context()            
            
            if not self.verifycert:
                ctx.check_hostname = False
                ctx.verify_mode = ssl.CERT_NONE
 
            req = urllib2.Request(self.server, data, {'Content-Type': 'application/json'})
            f = urllib2.urlopen(req,context=ctx)
            response = f.read()
            f.close()
            return json.loads(response)
        except:
            return "BROKENLINK"
 
 
 
    def decrypt(self,msg,sender):
        ''' Placeholder
        '''
                
        try:       
            key = self.roompass
            if sender == "SYSTEM":
                key = self.syskey
                
            return str(self.gpg.decrypt(msg.decode("base64"),passphrase=key))
        
        except:
            return False
        
    
 
    def encrypt(self,msg):
        ''' Placeholder
        '''
        
        crypted = self.gpg.encrypt(msg,None,passphrase=self.roompass,symmetric="AES256",armor=False)
        return crypted.data.encode('base64')
 
 
    def hashpw(self,passw):
        ''' Placeholder
        '''
        return passw
 
 
    def genpassw(self,N=16):
        ''' Generate a random string of chars to act as a password
        '''
        
        return ''.join(random.SystemRandom().choice(string.ascii_uppercase + string.digits).encode('utf-8') for _ in range(N))
 
 
 
class NotInRoom(Exception):
    def __init__(self,cmd):
        Exception.__init__(self,'Message not sent')
 
 
class UnableTo(Exception):
    def __init__(self,action,cmd):
        Exception.__init__(self,'Could not %s: %s' % (action,cmd))
 
 
class InvalidCommand(Exception):
    def __init__(self,cmd):
        Exception.__init__(self,'Command is invalid: %s' % (cmd,))
 
 
class Command(object):
    """ Base class to manage commands in commander
similar to cmd.Cmd in standard library
just extend with do_something  method to handle your commands"""
 
    def __init__(self,quit_commands=['/q','/quit','/exit'], help_commands=['/help','/?', '/h']):
        self._quit_cmd=quit_commands
        self._help_cmd=help_commands
        
    def __call__(self,line):
        global msg
        tokens=line.split()
        cmd=tokens[0].lower()
        args=tokens[1:]
        
        if cmd[0] == "/":
            # It's a command
            cmd = cmd[1:]
            
            
            if cmd == "me":
                #/me [string]
                r = msg.sendMsg(' '.join(args),'do')
                if not r:
                    raise NotInRoom(line)
                return
 
            
            if cmd == "ban":
                # /kick [user]
                
                if len(args) < 1:
                    raise InvalidCommand(line)
                
                
                m = msg.kickUser(args[0],True)
                return
                        
            
            if cmd == "join":
                # /join [room] [password] [username] 
                
                if len(args) < 3:
                    raise InvalidCommand(line)
                    return
                
                if not msg.joinRoom(args[2],args[0],args[1]):
                    raise UnableTo('join',line)
                return
            
            
            if cmd == "kick":
                # /kick [user]
                
                if len(args) < 1:
                    raise InvalidCommand(line)
                
                
                m = msg.kickUser(args[0])
                return
            
            
            if cmd == "leave":
                # /leave
                if not msg.leaveRoom():
                    raise UnableTo('leave',line)
                    return
                
                global c
                c.output('Left the room','magenta')
                return
 
 
            if cmd == 'msg':
                # /msg ben Hello ben this is a DM
                line = ' '.join(args[1:])
                r = msg.sendDirectMsg(line,args[0])
                if not r:
                    raise NotInRoom(line)
                
                # Otherwise push a copy of the message to display
                # cos we won't get this one back from pollMsg
                global c
                
                m = "%s DM %s>%s" % (msg.user,args[0],line)
                
                c.output(m,'blue')
                
                return
 
        
            if cmd == "room":
                
                # /room close [roompass]
                if args[0] == "close":
                    if len(args) < 2:
                        raise InvalidCommand('/room close [pass]')
                    
                    if not msg.closeRoom():
                        raise UnableTo('Close Room','')
                                        
                    return
                
                
                # /room create [roomname] [[user]]
                if args[0] == "create":
                    
                    if len(args) < 3:
                        args[2] = False
                    
                    n = msg.createRoom(args[1],args[2])
                    if not n:
                        raise UnableTo('create room',line)
                        return
                    
                    # Seperate out the return value
                    rm = n[0]
                    up = n[1] # user specific password
                    global c
                    
                    # Generate a room password
                    p = msg.genpassw()
                    c.output('Created Room %s' %(rm))
                    c.output('To join the room, do /join %s %s:%s %s' %(args[1],p,up,args[2]))
                    return
                
                elif args[0] == "invite":
                    if len(args) < 2:
                        raise InvalidCommand(line)
                    
                    n = msg.inviteUser(args[1])
                    if not n:
                        raise UnableTo('invite user',line)
                        return
                    
                    global c
                    c.output('User %s may now join room' %(args[1],))
                    c.output('To join the room, they should do /join %s %s:%s %s' %(n[0],n[1],n[2],n[3]))
                    return                                        
                    
            if cmd in ["help",'h','?']:
                return self.help(args[0] if args else None)
            
            if cmd in ["exit",'q','quit']:
                return Commander.Exit
            
 
        if cmd in self._quit_cmd:
            return Commander.Exit
        elif hasattr(self, 'do_'+cmd):
            return getattr(self, 'do_'+cmd)(*args)
        else:
            # If it's not a command, then we're trying to send a message
            r = msg.sendMsg(line)
            if not r:
                raise NotInRoom(line)
            
        
    def help(self,cmd=None):
        def std_help():
            qc='|'.join(self._quit_cmd)
            hc ='|'.join(self._help_cmd)
            res='Type [%s] to quit program\n' % qc
            res += """Available commands: 
 
            /h                                                          Print this help text
 
            
            /join [room] [password] [username]                          Join a room
            /leave                                                      Leave current room
            /room create [roomname] [roompass] [admin user]             New room management 
            
            
            /room invite [user]                                         Invite a user into the current room
            /me [string]                                                Send an 'action' instead of a message
            /msg [user] message                                         Send a direct message to [user]
            
            Room Admin commands:
            
            /kick [user]                                                Kick a user out of the room (they can return)
            /ban [user]                                                 Kick a user out and disinvite them (they cannot return)
            /room close [roompass]                                      Kick all users out and close the room
            
            Once in a room, to send a message, just type it.
            
            
            """
            return res
        if not cmd:
            return std_help()
        else:
            try:
                fn=getattr(self,'do_'+cmd)
                doc=fn.__doc__
                return doc or 'No documentation available for %s'%cmd
            except AttributeError:
                return std_help()
 
class FocusMixin(object):
    def mouse_event(self, size, event, button, x, y, focus):
        if focus and hasattr(self, '_got_focus') and self._got_focus:
            self._got_focus()
        return super(FocusMixin,self).mouse_event(size, event, button, x, y, focus)    
    
class ListView(FocusMixin, urwid.ListBox):
    def __init__(self, model, got_focus, max_size=None):
        urwid.ListBox.__init__(self,model)
        self._got_focus=got_focus
        self.max_size=max_size
        self._lock=threading.Lock()
        
    def add(self,line):
        with self._lock:
            was_on_end=self.get_focus()[1] == len(self.body)-1
            if self.max_size and len(self.body)>self.max_size:
                del self.body[0]
            self.body.append(urwid.Text(line))
            last=len(self.body)-1
            if was_on_end:
                self.set_focus(last,'above')
        
    
 
class Input(FocusMixin, urwid.Edit):
    signals=['line_entered']
    def __init__(self, got_focus=None):
        urwid.Edit.__init__(self)
        self.history=deque(maxlen=1000)
        self._history_index=-1
        self._got_focus=got_focus
    
    def keypress(self, size, key):
        if key=='enter':
            line=self.edit_text.strip()
            if line:
                urwid.emit_signal(self,'line_entered', line)
                self.history.append(line)
            self._history_index=len(self.history)
            self.edit_text=u''
        if key=='up':
            
            self._history_index-=1
            if self._history_index< 0:
                self._history_index= 0
            else:
                self.edit_text=self.history[self._history_index]
        if key=='down':
            self._history_index+=1
            if self._history_index>=len(self.history):
                self._history_index=len(self.history) 
                self.edit_text=u''
            else:
                self.edit_text=self.history[self._history_index]
        else:
            urwid.Edit.keypress(self, size, key)
        
 
 
class Commander(urwid.Frame):
    """ Simple terminal UI with command input on bottom line and display frame above
similar to chat client etc.
Initialize with your Command instance to execute commands
and the start main loop Commander.loop().
You can also asynchronously output messages with Commander.output('message') """
 
    class Exit(object):
        pass
    
    PALLETE=[('reversed', urwid.BLACK, urwid.LIGHT_GRAY),
              ('normal', urwid.LIGHT_GRAY, urwid.BLACK),
              ('error', urwid.LIGHT_RED, urwid.BLACK),
              ('green', urwid.DARK_GREEN, urwid.BLACK),
              ('blue', urwid.LIGHT_BLUE, urwid.BLACK),
              ('magenta', urwid.DARK_MAGENTA, urwid.BLACK), 
              ('yellow', urwid.YELLOW, urwid.BLACK), 
              ('cyan', urwid.LIGHT_CYAN, urwid.BLACK), 
              ('brown', urwid.BROWN, urwid.BLACK), 
              
              ]
    
    
    def __init__(self, title, command_caption='Message:  (Tab to switch focus to upper frame, where you can scroll text)', cmd_cb=None, max_size=1000):
        self.header=urwid.Text(title)
        self.model=urwid.SimpleListWalker([])
        self.body=ListView(self.model, lambda: self._update_focus(False), max_size=max_size )
        self.input=Input(lambda: self._update_focus(True))
        foot=urwid.Pile([urwid.AttrMap(urwid.Text(command_caption), 'reversed'),
                        urwid.AttrMap(self.input,'normal')])
        urwid.Frame.__init__(self, 
                             urwid.AttrWrap(self.body, 'normal'),
                             urwid.AttrWrap(self.header, 'reversed'),
                             foot)
        self.set_focus_path(['footer',1])
        self._focus=True
        urwid.connect_signal(self.input,'line_entered',self.on_line_entered)
        self._cmd=cmd_cb
        self._output_styles=[s[0] for s in self.PALLETE]
        self.eloop=None
        
    def loop(self, handle_mouse=False):
        self.eloop=urwid.MainLoop(self, self.PALLETE, handle_mouse=handle_mouse)
        self._eloop_thread=threading.current_thread()
        self.eloop.run()
        
    def on_line_entered(self,line):
        if self._cmd:
            try:
                res = self._cmd(line)
            except Exception,e:
                self.output('Error: %s'%e, 'error')
                return
            if res==Commander.Exit:
                raise urwid.ExitMainLoop()
            elif res:
                self.output(str(res))
        else:
            if line in ('q','quit','exit'):
                raise urwid.ExitMainLoop()
            else:
                self.output(line)
    
    def output(self, line, style=None):
        if style and style in self._output_styles:
                line=(style,line) 
        self.body.add(line)
        #since output could be called asynchronously form other threads we need to refresh screen in these cases
        if self.eloop and self._eloop_thread != threading.current_thread():
            self.eloop.draw_screen()
        
        
    def _update_focus(self, focus):
        self._focus=focus
        
    def switch_focus(self):
        if self._focus:
            self.set_focus('body')
            self._focus=False
        else:
            self.set_focus_path(['footer',1])
            self._focus=True
        
    def keypress(self, size, key):
        if key=='tab':
            self.switch_focus()
        return urwid.Frame.keypress(self, size, key)
        
 
 
def handle_cmdline_opts(argv,msg):
    ''' Process  any commandline options
    '''
    
    if argv[-1][0:2] == 'ht':
        msg.server=argv[-1]
        
    if "--verify" in argv:
        msg.verifycert = True
 
    return msg
 
    
if __name__=='__main__':
        
    msg = msgHandler()
    
    if len(sys.argv) > 1:
        msg = handle_cmdline_opts(sys.argv,msg)
    
    
    class TestCmd(Command):
        def do_echo(self, *args):
            '''echo - Just echos all arguments'''
            return ' '.join(args)
        def do_raise(self, *args):
            raise Exception('Some Error')
        
    c=Commander('LocalChat', cmd_cb=TestCmd())
    
    #Test asynch output -  e.g. comming from different thread
    import time
    def run():
        state=1
        while True:
            time.sleep(1)
            
            m = msg.pollForMessage()
            
            if m == "BROKENLINK":
                if state == 1:
                    c.output("Server went away", 'Red')
                    state = 0
                continue
                
            if m:
                state = 1
                for i in m:
                    c.output(i[1], i[0])
                
    t=Thread(target=run)
    t.daemon=True
    t.start()
    
    #start main loop
    c.loop()