Mercurial > libervia-backend
annotate frontends/quick_frontend/quick_chat.py @ 121:03d8bcc67182
misc documentation
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Thu, 08 Jul 2010 14:19:30 +0800 |
| parents | 1ca5f254ce41 |
| children | a86607e5cf38 |
| rev | line source |
|---|---|
| 0 | 1 #!/usr/bin/python |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 """ | |
| 5 helper class for making a SAT frontend | |
| 57 | 6 Copyright (C) 2009, 2010 Jérôme Poisson (goffi@goffi.org) |
| 0 | 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, error | |
| 23 from tools.jid import JID | |
| 24 | |
| 25 | |
| 26 | |
| 27 class QuickChat(): | |
| 28 | |
| 72 | 29 def __init__(self, target, host, type='one2one'): |
| 30 self.target = target | |
| 0 | 31 self.host = host |
| 72 | 32 self.type = type |
| 85 | 33 self.id = "" |
| 79 | 34 self.nick = None |
| 85 | 35 self.occupants = set() |
| 72 | 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 | |
| 0 | 42 |
| 120 | 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 | |
| 52 def replaceUser(self, nick): | |
| 53 """Add user if it is not in the group list""" | |
| 54 debug (_("Replacing user %s") % nick) | |
| 55 if self.type != "group": | |
| 56 error (_("[INTERNAL] trying to replace user for a non group chat window")) | |
| 57 raise Exception("INTERNAL ERROR") #TODO: raise proper Exception here | |
| 58 | |
| 79 | 59 def setUserNick(self, nick): |
| 60 """Set the nick of the user, usefull for e.g. change the color of the user""" | |
| 61 self.nick = nick | |
| 62 | |
| 120 | 63 def removeUser(self, nick): |
| 64 """Remove a user from the group list""" | |
| 65 debug(_("Removing user %s") % nick) | |
| 66 if self.type != "group": | |
| 67 error (_("[INTERNAL] trying to remove user for a non group chat window")) | |
| 68 raise Exception("INTERNAL ERROR") #TODO: raise proper Exception here | |
| 69 | |
| 70 def setSubject(self, subject): | |
| 71 """Set title for a group chat""" | |
| 72 debug(_("Setting subject to %s") % subject) | |
| 73 if self.type != "group": | |
| 74 error (_("[INTERNAL] trying to set subject for a non group chat window")) | |
| 75 raise Exception("INTERNAL ERROR") #TODO: raise proper Exception here | |
| 76 | |
|
67
0e50dd3a234a
message sending bug fixes + sortilege update
Goffi <goffi@goffi.org>
parents:
57
diff
changeset
|
77 def historyPrint(self, size=20, keep_last=False, profile='@NONE@'): |
| 0 | 78 """Print the initial history""" |
| 70 | 79 debug (_("now we print history")) |
| 72 | 80 history=self.host.bridge.getHistory(self.host.profiles[profile]['whoami'].short, self.target, 20) |
| 0 | 81 stamps=history.keys() |
| 82 stamps.sort() | |
| 83 for stamp in stamps: | |
|
67
0e50dd3a234a
message sending bug fixes + sortilege update
Goffi <goffi@goffi.org>
parents:
57
diff
changeset
|
84 self.printMessage(JID(history[stamp][0]), history[stamp][1], profile, stamp) |
| 0 | 85 if keep_last: ##FIXME hack for sortilege |
| 86 self.last_history = stamps[-1] if stamps else None | |
| 87 | |
|
67
0e50dd3a234a
message sending bug fixes + sortilege update
Goffi <goffi@goffi.org>
parents:
57
diff
changeset
|
88 def printMessage(self, from_jid, msg, profile, timestamp): |
| 0 | 89 """Print message in chat window. Must be implemented by child class""" |
| 90 raise NotImplementedError | |
| 91 |