Mercurial > libervia-backend

comparison frontends/src/quick_frontend/quick_chat.py @ 223:86d249b6d9b7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Files reorganisation
author Goffi <goffi@goffi.org>
date Wed, 29 Dec 2010 01:06:29 +0100
parents frontends/quick_frontend/quick_chat.py@9face609f83c
children fd9b7834d98a
comparison
equal deleted inserted replaced
222:3198bfd66daa 223:86d249b6d9b7
1 #!/usr/bin/python
2 # -*- coding: utf-8 -*-
3
4 """
5 helper class for making a SAT frontend
6 Copyright (C) 2009, 2010 Jérôme Poisson (goffi@goffi.org)
7
8 This program is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 """
21
22 from logging import debug, info, warning, error
23 from tools.jid import JID
24
25
26
27 class QuickChat():
28
29 def __init__(self, target, host, type='one2one'):
30 self.target = target
31 self.host = host
32 self.type = type
33 self.id = ""
34 self.nick = None
35 self.occupants = set()
36
37 def setType(self, type):
38 """Set the type of the chat
39 @param type: can be 'one2one' for single conversation or 'group' for chat à la IRC
40 """
41 self.type = type
42
43 def setPresents(self, nicks):
44 """Set the users presents in the contact list for a group chat
45 @param nicks: list of nicknames
46 """
47 debug (_("Adding users %s to room") % nicks)
48 if self.type != "group":
49 error (_("[INTERNAL] trying to set presents nicks for a non group chat window"))
50 raise Exception("INTERNAL ERROR") #TODO: raise proper Exception here
51 self.occupants.update(nicks)
52
53 def replaceUser(self, nick):
54 """Add user if it is not in the group list"""
55 debug (_("Replacing user %s") % nick)
56 if self.type != "group":
57 error (_("[INTERNAL] trying to replace user for a non group chat window"))
58 raise Exception("INTERNAL ERROR") #TODO: raise proper Exception here
59 len_before = len(self.occupants)
60 self.occupants.add(nick)
61 if len_before != len(self.occupants):
62 self.printInfo("=> %s has joined the room" % nick)
63
64 def setUserNick(self, nick):
65 """Set the nick of the user, usefull for e.g. change the color of the user"""
66 self.nick = nick
67
68 def removeUser(self, nick):
69 """Remove a user from the group list"""
70 debug(_("Removing user %s") % nick)
71 if self.type != "group":
72 error (_("[INTERNAL] trying to remove user for a non group chat window"))
73 raise Exception("INTERNAL ERROR") #TODO: raise proper Exception here
74 self.occupants.remove(nick)
75 self.printInfo("<= %s has left the room" % nick)
76
77 def setSubject(self, subject):
78 """Set title for a group chat"""
79 debug(_("Setting subject to %s") % subject)
80 if self.type != "group":
81 error (_("[INTERNAL] trying to set subject for a non group chat window"))
82 raise Exception("INTERNAL ERROR") #TODO: raise proper Exception here
83
84 def historyPrint(self, size=20, keep_last=False, profile='@NONE@'):
85 """Print the initial history"""
86 debug (_("now we print history"))
87 history=self.host.bridge.getHistory(self.host.profiles[profile]['whoami'].short, self.target, 20)
88 stamps=history.keys()
89 stamps.sort()
90 for stamp in stamps:
91 self.printMessage(JID(history[stamp][0]), history[stamp][1], profile, stamp)
92 if keep_last: ##FIXME hack for sortilege
93 self.last_history = stamps[-1] if stamps else None
94
95 def _get_nick(self, jid):
96 """Return nick of this jid when possible"""
97 return jid.resource if self.type == "group" else (self.host.CM.getAttr(jid,'nick') or self.host.CM.getAttr(jid,'name') or jid.node)
98
99 def printMessage(self, from_jid, msg, profile, timestamp):
100 """Print message in chat window. Must be implemented by child class"""
101 jid=JID(from_jid)
102 nick = self._get_nick(jid)
103 mymess = (jid.resource == self.nick) if self.type == "group" else (jid.short == self.host.profiles[profile]['whoami'].short) #mymess = True if message comes from local user
104 if msg.startswith('/me '):
105 self.printInfo('* %s %s' % (nick, msg[4:]),type='me')
106 return
107 return jid, nick, mymess
108
109 def printInfo(self, msg, type='normal'):
110 """Print general info
111 @param msg: message to print
112 @type: one of:
113 normal: general info like "toto has joined the room"
114 me: "/me" information like "/me clenches his fist" ==> "toto clenches his fist"
115 """
116 raise NotImplementedError
117
118
119 def startGame(self, game_type, referee, players):
120 """Configure the chat window to start a game"""
121 #No need to raise an error as game are not mandatory
122 warning(_('startGame is not implemented in this frontend'))
123
124 def getGame(self, game_type):
125 """Return class managing the game type"""
126 #No need to raise an error as game are not mandatory
127 warning(_('getGame is not implemented in this frontend'))