backend, frontends: message refactoring (huge commit):
/!\ several features are temporarily disabled, like notifications in frontends
next step in refactoring, with the following changes:
- jp: updated jp message to follow changes in backend/bridge
- jp: added --lang, --subject, --subject_lang, and --type options to jp message + fixed unicode handling for jid
- quick_frontend (QuickApp, QuickChat):
- follow backend changes
- refactored chat, message are now handled in OrderedDict and uid are kept so they can be updated
- Message and Occupant classes handle metadata, so frontend just have to display them
- Primitivus (Chat):
- follow backend/QuickFrontend changes
- info & standard messages are handled in the same MessageWidget class
- improved/simplified handling of messages, removed update() method
- user joined/left messages are merged when next to each other
- a separator is shown when message is received while widget is out of focus, so user can quickly see the new messages
- affiliation/role are shown (in a basic way for now) in occupants panel
- removed "/me" messages handling, as it will be done by a backend plugin
- message language is displayed when available (only one language per message for now)
- fixed :history and :search commands
- core (constants): new constants for messages type, XML namespace, entity type
- core: *Message methods renamed to follow new code sytle (e.g. sendMessageToBridge => messageSendToBridge)
- core (messages handling): fixed handling of language
- core (messages handling): mes_data['from'] and ['to'] are now jid.JID
- core (core.xmpp): reorganised message methods, added getNick() method to client.roster
- plugin text commands: fixed plugin and adapted to new messages behaviour. client is now used in arguments instead of profile
- plugins: added information for cancellation reason in CancelError calls
- plugin XEP-0045: various improvments, but this plugin still need work:
- trigger is used to avoid message already handled by the plugin to be handled a second time
- changed the way to handle history, the last message from DB is checked and we request only messages since this one, in seconds (thanks Poezio folks :))
- subject reception is waited before sending the roomJoined signal, this way we are sure that everything including history is ready
- cmd_* method now follow the new convention with client instead of profile
- roomUserJoined and roomUserLeft messages are removed, the events are now handled with info message with a "ROOM_USER_JOINED" info subtype
- probably other forgotten stuffs :p
This commit is contained in:
parent
feadc8c89e
commit
a7de473107
7 changed files with 987 additions and 598 deletions
|
|
@ -554,7 +554,7 @@ class DBusBridgeFrontend(BridgeFrontend):
|
|||
kwargs['error_handler'] = error_handler
|
||||
return self.db_core_iface.loadParamsTemplate(filename, **kwargs)
|
||||
|
||||
def messageSend(self, to_jid, message, subject='', mess_type="auto", extra={}, profile_key="@NONE@", callback=None, errback=None):
|
||||
def messageSend(self, to_jid, message, subject={}, mess_type="auto", extra={}, profile_key="@NONE@", callback=None, errback=None):
|
||||
if callback is None:
|
||||
error_handler = None
|
||||
else:
|
||||
|
|
|
|||
|
|
@ -20,6 +20,7 @@
|
|||
from sat_frontends.jp import base
|
||||
import sys
|
||||
from sat.core.i18n import _
|
||||
from sat.core.constants import Const as C
|
||||
from sat.tools.utils import clean_ustr
|
||||
|
||||
__commands__ = ["Message"]
|
||||
|
|
@ -31,9 +32,13 @@ class Send(base.CommandBase):
|
|||
super(Send, self).__init__(host, 'send', help=_('send a message to a contact'))
|
||||
|
||||
def add_parser_options(self):
|
||||
self.parser.add_argument("-l", "--lang", type=str, default='', help=_("language of the message"))
|
||||
self.parser.add_argument("-s", "--separate", action="store_true", help=_("separate xmpp messages: send one message per line instead of one message alone."))
|
||||
self.parser.add_argument("-n", "--new-line", action="store_true", help=_("add a new line at the beginning of the input (usefull for ascii art ;))"))
|
||||
self.parser.add_argument("jid", type=str, help=_("the destination jid"))
|
||||
self.parser.add_argument("-S", "--subject", type=base.unicode_decoder, help=_("subject of the message"))
|
||||
self.parser.add_argument("-L", "--subject_lang", type=str, default='', help=_("language of subject"))
|
||||
self.parser.add_argument("-t", "--type", choices=C.MESS_TYPE_STANDARD + (C.MESS_TYPE_AUTO,), default=C.MESS_TYPE_AUTO, help=_("type of the message"))
|
||||
self.parser.add_argument("jid", type=base.unicode_decoder, help=_("the destination jid"))
|
||||
|
||||
def start(self):
|
||||
jids = self.host.check_jids([self.args.jid])
|
||||
|
|
@ -46,21 +51,25 @@ class Send(base.CommandBase):
|
|||
@param dest_jid: destination jid
|
||||
"""
|
||||
header = "\n" if self.args.new_line else ""
|
||||
if self.args.subject is None:
|
||||
subject = {}
|
||||
else:
|
||||
subject = {self.args.subject_lang: self.args.subject}
|
||||
|
||||
if self.args.separate: #we send stdin in several messages
|
||||
|
||||
if header:
|
||||
self.host.bridge.sendMessage(dest_jid, header, profile_key=self.profile, callback=lambda: None, errback=lambda ignore: ignore)
|
||||
self.host.bridge.messageSend(dest_jid, {self.args.lang: header}, subject, self.args.type, profile_key=self.profile, callback=lambda: None, errback=lambda ignore: ignore)
|
||||
|
||||
while (True):
|
||||
line = clean_ustr(sys.stdin.readline().decode('utf-8','ignore'))
|
||||
if not line:
|
||||
break
|
||||
self.host.bridge.sendMessage(dest_jid, line.replace("\n",""), profile_key=self.host.profile, callback=lambda: None, errback=lambda ignore: ignore)
|
||||
self.host.bridge.messageSend(dest_jid, {self.args.lang: line.replace("\n","")}, subject, self.args.type, profile_key=self.host.profile, callback=lambda: None, errback=lambda ignore: ignore)
|
||||
|
||||
else:
|
||||
msg = header + clean_ustr(u"".join([stream.decode('utf-8','ignore') for stream in sys.stdin.readlines()]))
|
||||
self.host.bridge.sendMessage(dest_jid, msg, profile_key=self.host.profile, callback=lambda: None, errback=lambda ignore: ignore)
|
||||
self.host.bridge.messageSend(dest_jid, {self.args.lang: msg}, subject, self.args.type, profile_key=self.host.profile, callback=lambda: None, errback=lambda ignore: ignore)
|
||||
|
||||
|
||||
class Message(base.CommandBase):
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ log = logging.getLogger(__name__)
|
|||
import urwid
|
||||
from urwid_satext import sat_widgets
|
||||
from sat_frontends.quick_frontend import quick_widgets
|
||||
from sat_frontends.quick_frontend.quick_chat import QuickChat
|
||||
from sat_frontends.quick_frontend import quick_chat
|
||||
from sat_frontends.quick_frontend import quick_games
|
||||
from sat_frontends.primitivus import game_tarot
|
||||
from sat_frontends.primitivus.constants import Const as C
|
||||
|
|
@ -31,19 +31,63 @@ from sat_frontends.primitivus.keys import action_key_map as a_key
|
|||
from sat_frontends.primitivus.widget import PrimitivusWidget
|
||||
import time
|
||||
from sat_frontends.tools import jid
|
||||
from functools import total_ordering
|
||||
import bisect
|
||||
|
||||
|
||||
class ChatText(urwid.FlowWidget):
|
||||
"""Manage the printing of chat message"""
|
||||
class MessageWidget(urwid.WidgetWrap):
|
||||
|
||||
def __init__(self, parent, timestamp, nick, my_mess, message, align='left', is_info=False):
|
||||
self.parent = parent
|
||||
self.timestamp = time.localtime(timestamp)
|
||||
self.nick = nick
|
||||
self.my_mess = my_mess
|
||||
self.message = unicode(message)
|
||||
self.align = align
|
||||
self.is_info = is_info
|
||||
def __init__(self, mess_data):
|
||||
"""
|
||||
@param mess_data(quick_chat.Message, None): message data
|
||||
None: used only for non text widgets (e.g.: focus separator)
|
||||
"""
|
||||
self.mess_data = mess_data
|
||||
mess_data.widgets.add(self)
|
||||
self.timestamp = time.localtime(mess_data.timestamp)
|
||||
super(MessageWidget, self).__init__(urwid.Text(self.markup))
|
||||
|
||||
@property
|
||||
def markup(self):
|
||||
return self._generateInfoMarkup() if self.mess_data.type == C.MESS_TYPE_INFO else self._generateMarkup()
|
||||
|
||||
@property
|
||||
def info_type(self):
|
||||
return self.mess_data.info_type
|
||||
|
||||
@property
|
||||
def parent(self):
|
||||
return self.mess_data.parent
|
||||
|
||||
@property
|
||||
def message(self):
|
||||
"""Return currently displayed message"""
|
||||
message = self.mess_data.message
|
||||
if self.parent.lang in message:
|
||||
self.selected_lang = self.parent.lang
|
||||
return message[self.parent.lang]
|
||||
try:
|
||||
self.selected_lang = ''
|
||||
return message['']
|
||||
except KeyError:
|
||||
try:
|
||||
lang, mess = message.iteritems().next()
|
||||
self.selected_lang = lang
|
||||
return mess
|
||||
except StopIteration:
|
||||
log.error(u"Can't find message for uid {}".format(self.mess_data.uid))
|
||||
|
||||
@message.setter
|
||||
def message(self, value):
|
||||
self.mess_data.message = {'':value}
|
||||
self._w.set_text(self.markup)
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
try:
|
||||
return self.mess_data.type
|
||||
except AttributeError:
|
||||
return C.MESS_TYPE_INFO
|
||||
|
||||
def selectable(self):
|
||||
return True
|
||||
|
|
@ -51,42 +95,103 @@ class ChatText(urwid.FlowWidget):
|
|||
def keypress(self, size, key):
|
||||
return key
|
||||
|
||||
def rows(self, size, focus=False):
|
||||
return self.display_widget(size, focus).rows(size, focus)
|
||||
def get_cursor_coords(self, size):
|
||||
return 0, 0
|
||||
|
||||
def render(self, size, focus=False):
|
||||
canvas = urwid.CompositeCanvas(self.display_widget(size, focus).render(size, focus))
|
||||
# Text widget doesn't render cursor, but we want one
|
||||
# so we add it here
|
||||
canvas = urwid.CompositeCanvas(self._w.render(size, focus))
|
||||
if focus:
|
||||
canvas.set_cursor(self.get_cursor_coords(size))
|
||||
return canvas
|
||||
|
||||
def _generateInfoMarkup(self):
|
||||
return ('info_msg', self.message)
|
||||
|
||||
def _generateMarkup(self):
|
||||
"""Generate text markup according to message data and Widget options"""
|
||||
markup = []
|
||||
d = self.mess_data
|
||||
|
||||
# timestamp
|
||||
if self.parent.show_timestamp:
|
||||
# if the message was sent before today, we print the full date
|
||||
time_format = "%c" if self.timestamp < self.parent.day_change else "%H:%M"
|
||||
markup.append(('date', "[{}]".format(time.strftime(time_format, self.timestamp).decode('utf-8'))))
|
||||
|
||||
# nickname
|
||||
if self.parent.show_short_nick:
|
||||
markup.append(('my_nick' if d.own_mess else 'other_nick', "**" if d.own_mess else "*"))
|
||||
else:
|
||||
markup.append(('my_nick' if d.own_mess else 'other_nick', u"[{}] ".format(d.nick or '')))
|
||||
|
||||
msg = self.message # needed to generate self.selected_lang
|
||||
|
||||
if self.selected_lang:
|
||||
markup.append(("msg_lang", u"[{}] ".format(self.selected_lang)))
|
||||
|
||||
# message body
|
||||
markup.append(msg)
|
||||
|
||||
return markup
|
||||
|
||||
@total_ordering
|
||||
class OccupantWidget(urwid.WidgetWrap):
|
||||
|
||||
def __init__(self, occupant_data):
|
||||
self.occupant_data = occupant_data
|
||||
occupant_data.widgets.add(self)
|
||||
markup = self._generateMarkup()
|
||||
super(OccupantWidget, self).__init__(urwid.Text(markup))
|
||||
|
||||
def __eq__(self, other):
|
||||
return self.occupant_data.nick == other.occupant_data.nick
|
||||
|
||||
def __lt__(self, other):
|
||||
return self.occupant_data.nick.lower() < other.occupant_data.nick.lower()
|
||||
|
||||
@property
|
||||
def parent(self):
|
||||
return self.mess_data.parent
|
||||
|
||||
def selectable(self):
|
||||
return True
|
||||
|
||||
def keypress(self, size, key):
|
||||
return key
|
||||
|
||||
def get_cursor_coords(self, size):
|
||||
return 0, 0
|
||||
|
||||
def display_widget(self, size, focus):
|
||||
render_txt = []
|
||||
if not self.is_info:
|
||||
if self.parent.show_timestamp:
|
||||
time_format = "%c" if self.timestamp < self.parent.day_change else "%H:%M" # if the message was sent before today, we print the full date
|
||||
render_txt.append(('date', "[%s]" % time.strftime(time_format, self.timestamp).decode('utf-8')))
|
||||
if self.parent.show_short_nick:
|
||||
render_txt.append(('my_nick' if self.my_mess else 'other_nick', "**" if self.my_mess else "*"))
|
||||
else:
|
||||
render_txt.append(('my_nick' if self.my_mess else 'other_nick', "[%s] " % (self.nick or '')))
|
||||
render_txt.append(self.message)
|
||||
txt_widget = urwid.Text(render_txt, align=self.align)
|
||||
if self.is_info:
|
||||
return urwid.AttrMap(txt_widget, 'info_msg')
|
||||
return txt_widget
|
||||
def render(self, size, focus=False):
|
||||
# Text widget doesn't render cursor, but we want one
|
||||
# so we add it here
|
||||
canvas = urwid.CompositeCanvas(self._w.render(size, focus))
|
||||
if focus:
|
||||
canvas.set_cursor(self.get_cursor_coords(size))
|
||||
return canvas
|
||||
|
||||
def _generateMarkup(self):
|
||||
# TODO: role and affiliation are shown in a Q&D way
|
||||
# should be more intuitive and themable
|
||||
o = self.occupant_data
|
||||
markup = []
|
||||
markup.append(('info_msg', '{}{} '.format(
|
||||
o.role[0].upper(),
|
||||
o.affiliation[0].upper(),
|
||||
)))
|
||||
markup.append(o.nick)
|
||||
return markup
|
||||
|
||||
|
||||
class Chat(PrimitivusWidget, QuickChat):
|
||||
class Chat(PrimitivusWidget, quick_chat.QuickChat):
|
||||
|
||||
def __init__(self, host, target, type_=C.CHAT_ONE2ONE, profiles=None):
|
||||
QuickChat.__init__(self, host, target, type_, profiles=profiles)
|
||||
self.content = urwid.SimpleListWalker([])
|
||||
self.text_list = urwid.ListBox(self.content)
|
||||
self.chat_widget = urwid.Frame(self.text_list)
|
||||
def __init__(self, host, target, type_=C.CHAT_ONE2ONE, occupants=None, subject=None, profiles=None):
|
||||
quick_chat.QuickChat.__init__(self, host, target, type_, occupants, subject, profiles=profiles)
|
||||
self.mess_walker = urwid.SimpleListWalker([])
|
||||
self.mess_widgets = urwid.ListBox(self.mess_walker)
|
||||
self.chat_widget = urwid.Frame(self.mess_widgets)
|
||||
self.chat_colums = urwid.Columns([('weight', 8, self.chat_widget)])
|
||||
self.pile = urwid.Pile([self.chat_colums])
|
||||
PrimitivusWidget.__init__(self, self.pile, self.target)
|
||||
|
|
@ -94,16 +199,28 @@ class Chat(PrimitivusWidget, QuickChat):
|
|||
# we must adapt the behaviour with the type
|
||||
if type_ == C.CHAT_GROUP:
|
||||
if len(self.chat_colums.contents) == 1:
|
||||
self.occupants_list = sat_widgets.GenericList([], option_type=sat_widgets.ClickableText, on_click=self._occupantsClicked)
|
||||
self.occupants_panel = sat_widgets.VerticalSeparator(self.occupants_list)
|
||||
self.occupants_walker = urwid.SimpleListWalker([])
|
||||
# TODO: put a real ContactPanel class here, based on FocusWidget ?
|
||||
self.occupants_widgets = urwid.ListBox(self.occupants_walker)
|
||||
# FIXME
|
||||
# , option_type=sat_widgets.ClickableText, on_click=self._occupantsClicked)
|
||||
self.occupants_panel = sat_widgets.VerticalSeparator(self.occupants_widgets)
|
||||
self._appendOccupantsPanel()
|
||||
occupants_list = sorted(self.occupants.keys(), key=lambda o:o.lower())
|
||||
for occupant in occupants_list:
|
||||
occupant_data = self.occupants[occupant]
|
||||
self.occupants_walker.append(OccupantWidget(occupant_data))
|
||||
|
||||
self.host.addListener('presence', self.presenceListener, [profiles])
|
||||
|
||||
# focus marker is a separator indicated last visible message before focus was lost
|
||||
self.focus_marker = None # link to current marker
|
||||
self.focus_marker_set = None # True if a new marker has been inserted
|
||||
self.day_change = time.strptime(time.strftime("%a %b %d 00:00:00 %Y")) # struct_time of day changing time
|
||||
self.show_timestamp = True
|
||||
self.show_short_nick = False
|
||||
self.show_title = 1 # 0: clip title; 1: full title; 2: no title
|
||||
self.subject = None
|
||||
self.postInit()
|
||||
|
||||
def keypress(self, size, key):
|
||||
if key == a_key['OCCUPANTS_HIDE']: # user wants to (un)hide the occupants panel
|
||||
|
|
@ -115,11 +232,11 @@ class Chat(PrimitivusWidget, QuickChat):
|
|||
self._appendOccupantsPanel()
|
||||
elif key == a_key['TIMESTAMP_HIDE']: # user wants to (un)hide timestamp
|
||||
self.show_timestamp = not self.show_timestamp
|
||||
for wid in self.content:
|
||||
for wid in self.mess_walker:
|
||||
wid._invalidate()
|
||||
elif key == a_key['SHORT_NICKNAME']: # user wants to (not) use short nick
|
||||
self.show_short_nick = not self.show_short_nick
|
||||
for wid in self.content:
|
||||
for wid in self.mess_walker:
|
||||
wid._invalidate()
|
||||
elif key == a_key['SUBJECT_SWITCH']: # user wants to (un)hide group's subject or change its apperance
|
||||
if self.subject:
|
||||
|
|
@ -160,76 +277,87 @@ class Chat(PrimitivusWidget, QuickChat):
|
|||
@param statuses: dict of statuses
|
||||
@param profile: %(doc_profile)s
|
||||
"""
|
||||
assert self.type == C.CHAT_GROUP
|
||||
if entity.bare != self.target:
|
||||
return
|
||||
self.update(entity)
|
||||
# FIXME: disable for refactoring, need to be checked and re-enabled
|
||||
return
|
||||
# assert self.type == C.CHAT_GROUP
|
||||
# if entity.bare != self.target:
|
||||
# return
|
||||
# self.update(entity)
|
||||
|
||||
def update(self, entity=None):
|
||||
"""Update one or all entities.
|
||||
def createMessage(self, message):
|
||||
self.appendMessage(message)
|
||||
|
||||
@param entity (jid.JID): entity to update
|
||||
def _user_moved(self, message):
|
||||
"""return true if message is a user left/joined message
|
||||
|
||||
@param message(quick_chat.Message): message to add
|
||||
"""
|
||||
contact_list = self.host.contact_lists[self.profile]
|
||||
if message.type != C.MESS_TYPE_INFO:
|
||||
return False
|
||||
try:
|
||||
info_type = message.extra['info_type']
|
||||
except KeyError:
|
||||
return False
|
||||
else:
|
||||
return info_type in quick_chat.ROOM_USER_MOVED
|
||||
|
||||
if self.type == C.CHAT_ONE2ONE: # only update the chat title
|
||||
states = self.getEntityStates(self.target)
|
||||
self.title_dynamic = ' '.join([u'({})'.format(state) for state in states.values()])
|
||||
self.host.redraw()
|
||||
return
|
||||
def appendMessage(self, message):
|
||||
"""Create a MessageWidget and append it
|
||||
|
||||
nicks = list(self.occupants)
|
||||
if entity is None: # rebuild all the occupants list
|
||||
values = []
|
||||
nicks.sort()
|
||||
for nick in nicks:
|
||||
values.append(self._buildOccupantMarkup(jid.newResource(self.target, nick)))
|
||||
self.occupants_list.changeValues(values)
|
||||
else: # add, remove or update only one occupant
|
||||
nick = entity.resource
|
||||
show = contact_list.getCache(entity, C.PRESENCE_SHOW)
|
||||
if show == C.PRESENCE_UNAVAILABLE or show is None:
|
||||
try:
|
||||
self.occupants_list.deleteValue(nick)
|
||||
except ValueError:
|
||||
pass
|
||||
else:
|
||||
values = self.occupants_list.getAllValues()
|
||||
markup = self._buildOccupantMarkup(entity)
|
||||
if not values: # room has just been created
|
||||
values = [markup]
|
||||
else: # add or update the occupant, keep the list sorted
|
||||
index = 0
|
||||
for entry in values:
|
||||
order = cmp(entry.value if hasattr(entry, 'value') else entry, nick)
|
||||
if order < 0:
|
||||
index += 1
|
||||
continue
|
||||
if order > 0: # insert the occupant
|
||||
values.insert(index, markup)
|
||||
else: # update an existing occupant
|
||||
values[index] = markup
|
||||
break
|
||||
if index == len(values): # add to the end of the list
|
||||
values.append(markup)
|
||||
self.occupants_list.changeValues(values)
|
||||
self.host.redraw()
|
||||
|
||||
def _buildOccupantMarkup(self, entity):
|
||||
"""Return the option attributes for a MUC occupant.
|
||||
|
||||
@param nick (unicode): occupant nickname
|
||||
Can merge messages together is desirable (e.g.: multiple joined/leave)
|
||||
@param message(quick_chat.Message): message to add
|
||||
"""
|
||||
# TODO: for now it's not a markup but a simple text, the problem is that ListOption is unicode and not urwid.Text
|
||||
contact_list = self.host.contact_lists[self.profile]
|
||||
show = contact_list.getCache(entity, C.PRESENCE_SHOW)
|
||||
states = self.getEntityStates(entity)
|
||||
nick = entity.resource
|
||||
show_icon, entity_attr = C.PRESENCE.get(show, (u'', u'default')) # TODO: use entity_attr and return (nick, markup)
|
||||
text = "%s%s %s" % (u''.join(states.values()), show_icon, nick)
|
||||
return (nick, text)
|
||||
if self._user_moved(message):
|
||||
for wid in reversed(self.mess_walker):
|
||||
# we merge in/out messages if no message was sent meanwhile
|
||||
if not isinstance(wid, MessageWidget):
|
||||
continue
|
||||
if wid.mess_data.type != C.MESS_TYPE_INFO:
|
||||
break
|
||||
if wid.info_type in quick_chat.ROOM_USER_MOVED and wid.mess_data.nick == message.nick:
|
||||
try:
|
||||
count = wid.reentered_count
|
||||
except AttributeError:
|
||||
count = wid.reentered_count = 1
|
||||
nick = wid.mess_data.nick
|
||||
if message.info_type == quick_chat.ROOM_USER_LEFT:
|
||||
wid.message = _(u"<= {nick} has left the room ({count})").format(nick=nick, count=count)
|
||||
else:
|
||||
wid.message = _(u"<=> {nick} re-entered the room ({count})") .format(nick=nick, count=count)
|
||||
wid.reentered_count+=1
|
||||
return
|
||||
|
||||
if ((self.host.selected_widget != self or not self.host.x_notify.hasFocus())
|
||||
and self.focus_marker_set is not None):
|
||||
if not self.focus_marker_set and not self._locked and self.mess_walker:
|
||||
if self.focus_marker is not None:
|
||||
self.mess_walker.remove(self.focus_marker)
|
||||
self.focus_marker = urwid.Divider('—')
|
||||
self.mess_walker.append(self.focus_marker)
|
||||
self.focus_marker_set = True
|
||||
else:
|
||||
if self.focus_marker_set:
|
||||
self.focus_marker_set = False
|
||||
|
||||
if not message.message:
|
||||
log.error(u"Received an empty message for uid {}".format(message.uid))
|
||||
else:
|
||||
self.mess_walker.append(MessageWidget(message))
|
||||
self.mess_widgets.focus_position = len(self.mess_walker) - 1 # scroll down
|
||||
self.host.redraw() # FIXME: should not be necessary
|
||||
|
||||
def addUser(self, nick):
|
||||
occupant = super(Chat, self).addUser(nick)
|
||||
bisect.insort(self.occupants_walker, OccupantWidget(occupant))
|
||||
|
||||
def removeUser(self, occupant_data):
|
||||
occupant = super(Chat, self).removeUser(occupant_data)
|
||||
if occupant is not None:
|
||||
for widget in occupant.widgets:
|
||||
self.occupants_walker.remove(widget)
|
||||
|
||||
def _occupantsClicked(self, list_wid, clicked_wid):
|
||||
# FIXME: not called anymore after refactoring
|
||||
assert self.type == C.CHAT_GROUP
|
||||
nick = clicked_wid.getValue().value
|
||||
if nick == self.nick:
|
||||
|
|
@ -274,55 +402,32 @@ class Chat(PrimitivusWidget, QuickChat):
|
|||
|
||||
def setSubject(self, subject, wrap='space'):
|
||||
"""Set title for a group chat"""
|
||||
QuickChat.setSubject(self, subject)
|
||||
self.subject = subject
|
||||
quick_chat.QuickChat.setSubject(self, subject)
|
||||
self.subj_wid = urwid.Text(unicode(subject.replace('\n', '|') if wrap == 'clip' else subject),
|
||||
align='left' if wrap == 'clip' else 'center', wrap=wrap)
|
||||
self.chat_widget.header = urwid.AttrMap(self.subj_wid, 'title')
|
||||
self.host.redraw()
|
||||
|
||||
def clearHistory(self):
|
||||
"""Clear the content of this chat."""
|
||||
del self.content[:]
|
||||
## Messages
|
||||
|
||||
def afterHistoryPrint(self):
|
||||
def updateHistory(self, size=C.HISTORY_LIMIT_DEFAULT, search='', profile='@NONE@'):
|
||||
del self.mess_walker[:]
|
||||
if search:
|
||||
self.mess_walker.append(urwid.Text(_(u"Results for searching the globbing pattern: {}").format(search)))
|
||||
self.mess_walker.append(urwid.Text(_(u"Type ':history <lines>' to reset the chat history").format(search)))
|
||||
super(Chat, self).updateHistory(size, search, profile)
|
||||
|
||||
def _onHistoryPrinted(self):
|
||||
"""Refresh or scroll down the focus after the history is printed"""
|
||||
if len(self.content):
|
||||
self.text_list.focus_position = len(self.content) - 1 # scroll down
|
||||
self.host.redraw()
|
||||
for message in self.messages.itervalues():
|
||||
self.appendMessage(message)
|
||||
super(Chat, self)._onHistoryPrinted()
|
||||
|
||||
def onPrivateCreated(self, widget):
|
||||
self.host.contact_lists[widget.profile].specialResourceVisible(widget.target)
|
||||
|
||||
def printMessage(self, nick, my_message, message, timestamp, extra=None, profile=C.PROF_KEY_NONE):
|
||||
"""Print message in chat window.
|
||||
|
||||
@param nick (unicode): author nick
|
||||
@param my_message (boolean): True if profile is the author
|
||||
@param message (unicode): message content
|
||||
@param extra (dict): extra data
|
||||
"""
|
||||
new_text = ChatText(self, timestamp, nick, my_message, message)
|
||||
self.content.append(new_text)
|
||||
QuickChat.printMessage(self, nick, my_message, message, timestamp, extra, profile)
|
||||
|
||||
def printInfo(self, msg, type_='normal', extra=None):
|
||||
"""Print general info
|
||||
@param msg: message to print
|
||||
@type_: one of:
|
||||
normal: general info like "toto has joined the room"
|
||||
me: "/me" information like "/me clenches his fist" ==> "toto clenches his fist"
|
||||
@param timestamp (float): number of seconds since epoch
|
||||
"""
|
||||
if extra is None:
|
||||
extra = {}
|
||||
try:
|
||||
timestamp = float(extra['timestamp'])
|
||||
except KeyError:
|
||||
timestamp = None
|
||||
_widget = ChatText(self, timestamp, None, False, msg, is_info=True)
|
||||
self.content.append(_widget)
|
||||
QuickChat.printInfo(self, msg, type_, extra)
|
||||
def onSelected(self):
|
||||
self.focus_marker_set = False
|
||||
|
||||
def notify(self, contact="somebody", msg=""):
|
||||
"""Notify the user of a new message if primitivus doesn't have the focus.
|
||||
|
|
@ -330,12 +435,13 @@ class Chat(PrimitivusWidget, QuickChat):
|
|||
@param contact (unicode): contact who wrote to the users
|
||||
@param msg (unicode): the message that has been received
|
||||
"""
|
||||
# FIXME: not called anymore after refactoring
|
||||
if msg == "":
|
||||
return
|
||||
if self.text_list.get_focus()[1] == len(self.content) - 2:
|
||||
if self.mess_widgets.get_focus()[1] == len(self.mess_walker) - 2:
|
||||
# we don't change focus if user is not at the bottom
|
||||
# as that mean that he is probably watching discussion history
|
||||
self.text_list.focus_position = len(self.content) - 1
|
||||
self.mess_widgets.focus_position = len(self.mess_walker) - 1
|
||||
self.host.redraw()
|
||||
if not self.host.x_notify.hasFocus():
|
||||
if self.type == C.CHAT_ONE2ONE:
|
||||
|
|
@ -354,10 +460,11 @@ class Chat(PrimitivusWidget, QuickChat):
|
|||
# MISC EVENTS #
|
||||
|
||||
def onDelete(self):
|
||||
QuickChat.onDelete(self)
|
||||
# FIXME: to be checked after refactoring
|
||||
quick_chat.QuickChat.onDelete(self)
|
||||
if self.type == C.CHAT_GROUP:
|
||||
self.host.removeListener('presence', self.presenceListener)
|
||||
|
||||
|
||||
quick_widgets.register(QuickChat, Chat)
|
||||
quick_widgets.register(quick_chat.QuickChat, Chat)
|
||||
quick_widgets.register(quick_games.Tarot, game_tarot.TarotGame)
|
||||
|
|
|
|||
|
|
@ -32,10 +32,13 @@ class Const(constants.Const):
|
|||
('default_focus', 'default,bold', 'default'),
|
||||
('alert', 'default,underline', 'default'),
|
||||
('alert_focus', 'default,bold,underline', 'default'),
|
||||
# Messages
|
||||
('date', 'light gray', 'default'),
|
||||
('my_nick', 'dark red,bold', 'default'),
|
||||
('other_nick', 'dark cyan,bold', 'default'),
|
||||
('info_msg', 'yellow', 'default', 'bold'),
|
||||
('msg_lang', 'dark cyan', 'default'),
|
||||
|
||||
('menubar', 'light gray,bold', 'dark red'),
|
||||
('menubar_focus', 'light gray,bold', 'dark green'),
|
||||
('selected_menu', 'light gray,bold', 'dark green'),
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ class EditBar(sat_widgets.ModalEdit):
|
|||
self.host.messageSend(
|
||||
chat_widget.target,
|
||||
{'': editBar.get_edit_text()}, # TODO: handle language
|
||||
mess_type = "groupchat" if chat_widget.type == 'group' else "chat", # TODO: put this in QuickChat
|
||||
mess_type = C.MESS_TYPE_GROUPCHAT if chat_widget.type == C.CHAT_GROUP else C.MESS_TYPE_CHAT, # TODO: put this in QuickChat
|
||||
errback=lambda failure: self.host.notify(_("Error while sending message ({})").format(failure)),
|
||||
profile_key=chat_widget.profile
|
||||
)
|
||||
|
|
@ -139,19 +139,15 @@ class EditBar(sat_widgets.ModalEdit):
|
|||
limit = int(args[0])
|
||||
except (IndexError, ValueError):
|
||||
limit = 50
|
||||
widget.clearHistory()
|
||||
if limit > 0:
|
||||
widget.historyPrint(size=limit, profile=widget.profile)
|
||||
widget.updateHistory(size=limit, profile=widget.profile)
|
||||
elif command == 'search':
|
||||
widget = self.host.selected_widget
|
||||
if isinstance(widget, quick_chat.QuickChat):
|
||||
pattern = " ".join(args)
|
||||
if not pattern:
|
||||
self.host.notif_bar.addMessage(D_("Please specify the globbing pattern to search for"))
|
||||
widget.clearHistory()
|
||||
widget.printInfo(D_("Results for searching the globbing pattern: %s") % pattern, extra={'timestamp': 0})
|
||||
widget.historyPrint(size=C.HISTORY_LIMIT_NONE, search=pattern, profile=widget.profile)
|
||||
widget.printInfo(D_("Type ':history <lines>' to reset the chat history"))
|
||||
else:
|
||||
widget.updateHistory(size=C.HISTORY_LIMIT_NONE, search=pattern, profile=widget.profile)
|
||||
else:
|
||||
return
|
||||
self.set_edit_text('')
|
||||
|
|
@ -540,7 +536,8 @@ class PrimitivusApp(QuickApp, InputHistory):
|
|||
self.redraw()
|
||||
|
||||
def newWidget(self, widget):
|
||||
self.selectWidget(widget)
|
||||
if self.selected_widget is None:
|
||||
self.selectWidget(widget)
|
||||
|
||||
def selectWidget(self, widget):
|
||||
"""Display a widget if possible,
|
||||
|
|
@ -556,6 +553,12 @@ class PrimitivusApp(QuickApp, InputHistory):
|
|||
except KeyError:
|
||||
log.debug("No menu to delete")
|
||||
self.selected_widget = widget
|
||||
try:
|
||||
onSelected = self.selected_widget.onSelected
|
||||
except AttributeError:
|
||||
pass
|
||||
else:
|
||||
onSelected()
|
||||
self._visible_widgets = set([widget]) # XXX: we can only have one widget visible at the time for now
|
||||
self.contact_lists.select(None)
|
||||
|
||||
|
|
@ -722,11 +725,12 @@ class PrimitivusApp(QuickApp, InputHistory):
|
|||
log.error (_("FIXME FIXME FIXME: type [%s] not implemented") % type_)
|
||||
raise NotImplementedError
|
||||
|
||||
def roomJoinedHandler(self, room_jid_s, room_nicks, user_nick, profile):
|
||||
super(PrimitivusApp, self).roomJoinedHandler(room_jid_s, room_nicks, user_nick, profile)
|
||||
for contact_list in self.widgets.getWidgets(ContactList):
|
||||
if profile in contact_list.profiles:
|
||||
contact_list.setFocus(jid.JID(room_jid_s), True)
|
||||
def roomJoinedHandler(self, room_jid_s, room_nicks, user_nick, subject, profile):
|
||||
super(PrimitivusApp, self).roomJoinedHandler(room_jid_s, room_nicks, user_nick, subject, profile)
|
||||
# if self.selected_widget is None:
|
||||
# for contact_list in self.widgets.getWidgets(ContactList):
|
||||
# if profile in contact_list.profiles:
|
||||
# contact_list.setFocus(jid.JID(room_jid_s), True)
|
||||
|
||||
def progressStartedHandler(self, pid, metadata, profile):
|
||||
super(PrimitivusApp, self).progressStartedHandler(pid, metadata, profile)
|
||||
|
|
@ -745,7 +749,7 @@ class PrimitivusApp(QuickApp, InputHistory):
|
|||
def onJoinRoom(self, button, edit):
|
||||
self.removePopUp()
|
||||
room_jid = jid.JID(edit.get_edit_text())
|
||||
self.bridge.joinMUC(room_jid, self.profiles[self.current_profile].whoami.node, {}, self.current_profile, callback=lambda dummy: None, errback=self.dialogFailure)
|
||||
self.bridge.mucJoin(room_jid, self.profiles[self.current_profile].whoami.node, {}, self.current_profile, callback=lambda dummy: None, errback=self.dialogFailure)
|
||||
|
||||
#MENU EVENTS#
|
||||
def onConnectRequest(self, menu):
|
||||
|
|
|
|||
|
|
@ -122,13 +122,6 @@ class ProfileManager(object):
|
|||
#Now we open the MUC window where we already are:
|
||||
for room_args in rooms_args:
|
||||
self.host.roomJoinedHandler(*room_args, profile=self.profile)
|
||||
|
||||
self.bridge.getRoomsSubjects(self.profile, callback=self._plug_profile_gotRoomsSubjects)
|
||||
|
||||
def _plug_profile_gotRoomsSubjects(self, subjects_args):
|
||||
for subject_args in subjects_args:
|
||||
self.host.roomNewSubjectHandler(*subject_args, profile=self.profile)
|
||||
|
||||
#Presence must be requested after rooms are filled
|
||||
self.host.bridge.getPresenceStatuses(self.profile, callback=self._plug_profile_gotPresences)
|
||||
|
||||
|
|
@ -263,8 +256,6 @@ class QuickApp(object):
|
|||
self.registerSignal("actionResultExt", self.actionResultHandler)
|
||||
self.registerSignal("roomJoined", iface="plugin")
|
||||
self.registerSignal("roomLeft", iface="plugin")
|
||||
self.registerSignal("roomUserJoined", iface="plugin")
|
||||
self.registerSignal("roomUserLeft", iface="plugin")
|
||||
self.registerSignal("roomUserChangedNick", iface="plugin")
|
||||
self.registerSignal("roomNewSubject", iface="plugin")
|
||||
self.registerSignal("chatStateReceived", iface="plugin")
|
||||
|
|
@ -490,11 +481,8 @@ class QuickApp(object):
|
|||
|
||||
from_me = from_jid.bare == self.profiles[profile].whoami.bare
|
||||
target = to_jid if from_me else from_jid
|
||||
|
||||
chat_type = C.CHAT_GROUP if type_ == C.MESS_TYPE_GROUPCHAT else C.CHAT_ONE2ONE
|
||||
contact_list = self.contact_lists[profile]
|
||||
|
||||
chat_widget = self.widgets.getOrCreateWidget(quick_chat.QuickChat, target, type_=chat_type, on_new_widget=None, profile=profile)
|
||||
chat_widget = self.widgets.getOrCreateWidget(quick_chat.QuickChat, target, type_=C.CHAT_ONE2ONE, on_new_widget=None, profile=profile)
|
||||
|
||||
self.current_action_ids = set() # FIXME: to be removed
|
||||
self.current_action_ids_cb = {} # FIXME: to be removed
|
||||
|
|
@ -560,14 +548,14 @@ class QuickApp(object):
|
|||
|
||||
self.callListeners('presence', entity, show, priority, statuses, profile=profile)
|
||||
|
||||
def roomJoinedHandler(self, room_jid_s, room_nicks, user_nick, profile):
|
||||
def roomJoinedHandler(self, room_jid_s, occupants, user_nick, subject, profile):
|
||||
"""Called when a MUC room is joined"""
|
||||
log.debug(u"Room [%(room_jid)s] joined by %(profile)s, users presents:%(users)s" % {'room_jid': room_jid_s, 'profile': profile, 'users': room_nicks})
|
||||
log.debug(u"Room [{room_jid}] joined by {profile}, users presents:{users}".format(room_jid=room_jid_s, profile=profile, users=occupants.keys()))
|
||||
room_jid = jid.JID(room_jid_s)
|
||||
chat_widget = self.widgets.getOrCreateWidget(quick_chat.QuickChat, room_jid, type_=C.CHAT_GROUP, profile=profile)
|
||||
chat_widget = self.widgets.getOrCreateWidget(quick_chat.QuickChat, room_jid, type_=C.CHAT_GROUP, occupants=occupants, subject=subject, profile=profile)
|
||||
chat_widget.setUserNick(unicode(user_nick))
|
||||
self.contact_lists[profile].setSpecial(room_jid, C.CONTACT_SPECIAL_GROUP)
|
||||
chat_widget.update()
|
||||
# chat_widget.update()
|
||||
|
||||
def roomLeftHandler(self, room_jid_s, profile):
|
||||
"""Called when a MUC room is left"""
|
||||
|
|
@ -578,20 +566,6 @@ class QuickApp(object):
|
|||
self.widgets.deleteWidget(chat_widget)
|
||||
self.contact_lists[profile].removeContact(room_jid)
|
||||
|
||||
def roomUserJoinedHandler(self, room_jid_s, user_nick, user_data, profile):
|
||||
"""Called when an user joined a MUC room"""
|
||||
room_jid = jid.JID(room_jid_s)
|
||||
chat_widget = self.widgets.getOrCreateWidget(quick_chat.QuickChat, room_jid, type_=C.CHAT_GROUP, profile=profile)
|
||||
chat_widget.addUser(user_nick)
|
||||
log.debug(u"user [%(user_nick)s] joined room [%(room_jid)s]" % {'user_nick': user_nick, 'room_jid': room_jid})
|
||||
|
||||
def roomUserLeftHandler(self, room_jid_s, user_nick, user_data, profile):
|
||||
"""Called when an user joined a MUC room"""
|
||||
room_jid = jid.JID(room_jid_s)
|
||||
chat_widget = self.widgets.getOrCreateWidget(quick_chat.QuickChat, room_jid, type_=C.CHAT_GROUP, profile=profile)
|
||||
chat_widget.removeUser(user_nick)
|
||||
log.debug(u"user [%(user_nick)s] left room [%(room_jid)s]" % {'user_nick': user_nick, 'room_jid': room_jid})
|
||||
|
||||
def roomUserChangedNickHandler(self, room_jid_s, old_nick, new_nick, profile):
|
||||
"""Called when an user joined a MUC room"""
|
||||
room_jid = jid.JID(room_jid_s)
|
||||
|
|
@ -613,20 +587,20 @@ class QuickApp(object):
|
|||
@param state (unicode): new state
|
||||
@param profile (unicode): current profile
|
||||
"""
|
||||
log.debug(_(u"Received new chat state {} from {} [{}]").format(state, from_jid_s, profile))
|
||||
from_jid = jid.JID(from_jid_s) if from_jid_s != C.ENTITY_ALL else C.ENTITY_ALL
|
||||
contact_list = self.contact_lists[profile]
|
||||
for widget in self.widgets.getWidgets(quick_chat.QuickChat):
|
||||
if profile != widget.profile:
|
||||
continue
|
||||
to_display = C.USER_CHAT_STATES[state] if (state and widget.type == C.CHAT_GROUP) else state
|
||||
if widget.type == C.CHAT_GROUP and from_jid_s == C.ENTITY_ALL:
|
||||
for occupant in [jid.newResource(widget.target, nick) for nick in widget.occupants]:
|
||||
contact_list.setCache(occupant, 'chat_state', to_display)
|
||||
widget.update(occupant)
|
||||
elif from_jid.bare == widget.target.bare: # roster contact or MUC occupant
|
||||
contact_list.setCache(from_jid, 'chat_state', to_display)
|
||||
widget.update(from_jid)
|
||||
# log.debug(_(u"Received new chat state {} from {} [{}]").format(state, from_jid_s, profile))
|
||||
# from_jid = jid.JID(from_jid_s) if from_jid_s != C.ENTITY_ALL else C.ENTITY_ALL
|
||||
# contact_list = self.contact_lists[profile]
|
||||
# for widget in self.widgets.getWidgets(quick_chat.QuickChat):
|
||||
# if profile != widget.profile:
|
||||
# continue
|
||||
# to_display = C.USER_CHAT_STATES[state] if (state and widget.type == C.CHAT_GROUP) else state
|
||||
# if widget.type == C.CHAT_GROUP and from_jid_s == C.ENTITY_ALL:
|
||||
# for occupant in [jid.newResource(widget.target, nick) for nick in widget.occupants]:
|
||||
# contact_list.setCache(occupant, 'chat_state', to_display)
|
||||
# widget.update(occupant)
|
||||
# elif from_jid.bare == widget.target.bare: # roster contact or MUC occupant
|
||||
# contact_list.setCache(from_jid, 'chat_state', to_display)
|
||||
# widget.update(from_jid)
|
||||
|
||||
def psEventHandler(self, category, service_s, node, event_type, data, profile):
|
||||
"""Called when a PubSub event is received.
|
||||
|
|
|
|||
|
|
@ -20,11 +20,17 @@
|
|||
from sat.core.i18n import _
|
||||
from sat.core.log import getLogger
|
||||
log = getLogger(__name__)
|
||||
from sat_frontends.tools import jid
|
||||
from sat.core import exceptions
|
||||
from sat_frontends.quick_frontend import quick_widgets
|
||||
from sat_frontends.quick_frontend.constants import Const as C
|
||||
from collections import OrderedDict
|
||||
from datetime import datetime
|
||||
from sat_frontends.tools import jid
|
||||
|
||||
ROOM_USER_JOINED = 'ROOM_USER_JOINED'
|
||||
ROOM_USER_LEFT = 'ROOM_USER_LEFT'
|
||||
ROOM_USER_MOVED = (ROOM_USER_JOINED, ROOM_USER_LEFT)
|
||||
|
||||
# from datetime import datetime
|
||||
|
||||
try:
|
||||
# FIXME: to be removed when an acceptable solution is here
|
||||
|
|
@ -32,26 +38,109 @@ try:
|
|||
except (TypeError, AttributeError): # Error raised is not the same depending on pyjsbuild options
|
||||
unicode = str
|
||||
|
||||
# FIXME: day_format need to be settable (i18n)
|
||||
|
||||
class Message(object):
|
||||
"""Message metadata"""
|
||||
|
||||
def __init__(self, parent, uid, timestamp, from_jid, to_jid, msg, subject, type_, extra, profile):
|
||||
self.parent = parent
|
||||
self.profile = profile
|
||||
self.uid = uid
|
||||
self.timestamp = timestamp
|
||||
self.from_jid = from_jid
|
||||
self.to_jid = to_jid
|
||||
self.message = msg
|
||||
self.subject = subject
|
||||
self.type = type_
|
||||
self.extra = extra
|
||||
self.nick = self.getNick(from_jid)
|
||||
# own_mess is True if message was sent by profile's jid
|
||||
self.own_mess = (from_jid.resource == self.parent.nick) if self.parent.type == C.CHAT_GROUP else (from_jid.bare == self.host.profiles[profile].whoami.bare)
|
||||
self.widgets = set() # widgets linked to this message
|
||||
|
||||
@property
|
||||
def host(self):
|
||||
return self.parent.host
|
||||
|
||||
@property
|
||||
def info_type(self):
|
||||
return self.extra.get('info_type')
|
||||
|
||||
def getNick(self, entity):
|
||||
"""Return nick of an entity when possible"""
|
||||
contact_list = self.host.contact_lists[self.profile]
|
||||
if self.type == C.MESS_TYPE_INFO and self.info_type in ROOM_USER_MOVED:
|
||||
try:
|
||||
return self.extra['user_nick']
|
||||
except KeyError:
|
||||
log.error(u"extra data is missing user nick for uid {}".format(self.uid))
|
||||
return ""
|
||||
if self.parent.type == C.CHAT_GROUP or entity in contact_list.getSpecialExtras(C.CONTACT_SPECIAL_GROUP):
|
||||
return entity.resource or ""
|
||||
if entity.bare in contact_list:
|
||||
return contact_list.getCache(entity, 'nick') or contact_list.getCache(entity, 'name') or entity.node or entity
|
||||
return entity.node or entity
|
||||
|
||||
|
||||
class Occupant(object):
|
||||
"""Occupant metadata"""
|
||||
|
||||
def __init__(self, parent, data, profile):
|
||||
self.parent = parent
|
||||
self.profile = profile
|
||||
self.nick = data['nick']
|
||||
self.entity = data.get('entity')
|
||||
if not self.entity:
|
||||
self.entity = jid.JID(u"{}/{}".format(parent.target.bare, self.nick)),
|
||||
self.affiliation = data['affiliation']
|
||||
self.role = data['role']
|
||||
self.widgets = set() # widgets linked to this occupant
|
||||
|
||||
@property
|
||||
def host(self):
|
||||
return self.parent.host
|
||||
|
||||
|
||||
class QuickChat(quick_widgets.QuickWidget):
|
||||
|
||||
visible_states = ['chat_state']
|
||||
|
||||
def __init__(self, host, target, type_=C.CHAT_ONE2ONE, profiles=None):
|
||||
def __init__(self, host, target, type_=C.CHAT_ONE2ONE, occupants=None, subject=None, profiles=None):
|
||||
"""
|
||||
@param type_: can be C.CHAT_ONE2ONE for single conversation or C.CHAT_GROUP for chat à la IRC
|
||||
"""
|
||||
self.lang = '' # default language to use for messages
|
||||
quick_widgets.QuickWidget.__init__(self, host, target, profiles=profiles)
|
||||
self._locked = False # True when we are waiting for history/search
|
||||
# messageNew signals are cached when locked
|
||||
self._cache = []
|
||||
assert type_ in (C.CHAT_ONE2ONE, C.CHAT_GROUP)
|
||||
if type_ == C.CHAT_GROUP and target.resource:
|
||||
raise ValueError("A group chat entity can't have a resource")
|
||||
self.current_target = target
|
||||
self.type = type_
|
||||
self.id = "" # FIXME: to be removed
|
||||
self.nick = None
|
||||
if type_ == C.CHAT_GROUP:
|
||||
if target.resource:
|
||||
raise exceptions.InternalError(u"a group chat entity can't have a resource")
|
||||
self.nick = None
|
||||
self.occupants = {}
|
||||
self.setOccupants(occupants)
|
||||
else:
|
||||
if occupants is not None:
|
||||
raise exceptions.InternalError(u"only group chat can have occupants")
|
||||
self.messages = OrderedDict() # key: uid, value: Message instance
|
||||
self.games = {} # key=game name (unicode), value=instance of quick_games.RoomGame
|
||||
self.subject = subject
|
||||
|
||||
def postInit(self):
|
||||
"""Method to be called by frontend after widget is initialised
|
||||
|
||||
handle the display of history and subject
|
||||
"""
|
||||
self.historyPrint(profile=self.profile)
|
||||
if self.subject is not None:
|
||||
self.setSubject(self.subject)
|
||||
|
||||
## Widget management ##
|
||||
|
||||
def __str__(self):
|
||||
return u"Chat Widget [target: {}, type: {}, profile: {}]".format(self.target, self.type, self.profile)
|
||||
|
|
@ -74,109 +163,6 @@ class QuickChat(quick_widgets.QuickWidget):
|
|||
if target.resource:
|
||||
self.current_target = target # FIXME: tmp, must use resource priority throught contactList instead
|
||||
|
||||
@property
|
||||
def target(self):
|
||||
if self.type == C.CHAT_GROUP:
|
||||
return self.current_target.bare
|
||||
return self.current_target
|
||||
|
||||
@property
|
||||
def occupants(self):
|
||||
"""Return the occupants of a group chat (nicknames).
|
||||
|
||||
@return: set(unicode)
|
||||
"""
|
||||
if self.type != C.CHAT_GROUP:
|
||||
return set()
|
||||
contact_list = self.host.contact_lists[self.profile]
|
||||
return contact_list.getCache(self.target, C.CONTACT_RESOURCES).keys()
|
||||
|
||||
def manageMessage(self, entity, mess_type):
|
||||
"""Tell if this chat widget manage an entity and message type couple
|
||||
|
||||
@param entity (jid.JID): (full) jid of the sending entity
|
||||
@param mess_type (str): message type as given by messageNew
|
||||
@return (bool): True if this Chat Widget manage this couple
|
||||
"""
|
||||
if self.type == C.CHAT_GROUP:
|
||||
if mess_type == C.MESS_TYPE_GROUPCHAT and self.target == entity.bare:
|
||||
return True
|
||||
else:
|
||||
if mess_type != C.MESS_TYPE_GROUPCHAT and entity in self.targets:
|
||||
return True
|
||||
return False
|
||||
|
||||
def addUser(self, nick):
|
||||
"""Add user if it is not in the group list"""
|
||||
self.printInfo("=> %s has joined the room" % nick)
|
||||
|
||||
def removeUser(self, nick):
|
||||
"""Remove a user from the group list"""
|
||||
self.printInfo("<= %s has left the room" % nick)
|
||||
|
||||
def setUserNick(self, nick):
|
||||
"""Set the nick of the user, usefull for e.g. change the color of the user"""
|
||||
self.nick = nick
|
||||
|
||||
def changeUserNick(self, old_nick, new_nick):
|
||||
"""Change nick of a user in group list"""
|
||||
self.printInfo("%s is now known as %s" % (old_nick, new_nick))
|
||||
|
||||
def setSubject(self, subject):
|
||||
"""Set title for a group chat"""
|
||||
log.debug(_("Setting subject to %s") % subject)
|
||||
if self.type != C.CHAT_GROUP:
|
||||
log.error (_("[INTERNAL] trying to set subject for a non group chat window"))
|
||||
raise Exception("INTERNAL ERROR") #TODO: raise proper Exception here
|
||||
|
||||
def afterHistoryPrint(self):
|
||||
"""Refresh or scroll down the focus after the history is printed"""
|
||||
pass
|
||||
|
||||
def historyPrint(self, size=C.HISTORY_LIMIT_DEFAULT, search='', profile='@NONE@'):
|
||||
"""Print the current history
|
||||
|
||||
@param size (int): number of messages
|
||||
@param search (str): pattern to filter the history results
|
||||
@param profile (str): %(doc_profile)s
|
||||
"""
|
||||
log_msg = _(u"now we print the history")
|
||||
if size != C.HISTORY_LIMIT_DEFAULT:
|
||||
log_msg += _(u" (%d messages)" % size)
|
||||
log.debug(log_msg)
|
||||
|
||||
target = self.target.bare
|
||||
|
||||
def _historyGetCb(history):
|
||||
day_format = "%A, %d %b %Y" # to display the day change
|
||||
previous_day = datetime.now().strftime(day_format)
|
||||
for data in history:
|
||||
uid, timestamp, from_jid, to_jid, message, subject, type_, extra = data # FIXME: extra is unused !
|
||||
if ((self.type == C.CHAT_GROUP and type_ != C.MESS_TYPE_GROUPCHAT) or
|
||||
(self.type == C.CHAT_ONE2ONE and type_ == C.MESS_TYPE_GROUPCHAT)):
|
||||
continue
|
||||
message_day = datetime.fromtimestamp(timestamp).strftime(day_format)
|
||||
if previous_day != message_day:
|
||||
self.printDayChange(message_day)
|
||||
previous_day = message_day
|
||||
extra["timestamp"] = timestamp
|
||||
self.messageNew(uid, timestamp, jid.JID(from_jid), target, message, subject, type_, extra, profile)
|
||||
self.afterHistoryPrint()
|
||||
|
||||
def _historyGetEb(err):
|
||||
log.error(_("Can't get history"))
|
||||
|
||||
self.host.bridge.historyGet(unicode(self.host.profiles[profile].whoami.bare), unicode(target), size, True, search, profile, callback=_historyGetCb, errback=_historyGetEb)
|
||||
|
||||
def _get_nick(self, entity):
|
||||
"""Return nick of this entity when possible"""
|
||||
contact_list = self.host.contact_lists[self.profile]
|
||||
if self.type == C.CHAT_GROUP or entity in contact_list.getSpecialExtras(C.CONTACT_SPECIAL_GROUP):
|
||||
return entity.resource or ""
|
||||
if entity.bare in contact_list:
|
||||
return contact_list.getCache(entity, 'nick') or contact_list.getCache(entity, 'name') or entity.node or entity
|
||||
return entity.node or entity
|
||||
|
||||
def onPrivateCreated(self, widget):
|
||||
"""Method called when a new widget for private conversation (MUC) is created"""
|
||||
raise NotImplementedError
|
||||
|
|
@ -188,57 +174,171 @@ class QuickChat(quick_widgets.QuickWidget):
|
|||
"""
|
||||
return self.host.widgets.getOrCreateWidget(QuickChat, entity, type_=C.CHAT_ONE2ONE, force_hash=self.getPrivateHash(self.profile, entity), on_new_widget=self.onPrivateCreated, profile=self.profile) # we force hash to have a new widget, not this one again
|
||||
|
||||
def messageNew(self, uid, timestamp, from_jid, target, msg, subject, type_, extra, profile):
|
||||
@property
|
||||
def target(self):
|
||||
if self.type == C.CHAT_GROUP:
|
||||
return self.current_target.bare
|
||||
return self.current_target
|
||||
|
||||
## occupants ##
|
||||
|
||||
def setOccupants(self, occupants):
|
||||
"""set the whole list of occupants"""
|
||||
assert len(self.occupants) == 0
|
||||
for nick, data in occupants.iteritems():
|
||||
self.occupants[nick] = Occupant(
|
||||
self,
|
||||
data,
|
||||
self.profile
|
||||
)
|
||||
|
||||
def addUser(self, occupant_data):
|
||||
"""Add user if it is not in the group list"""
|
||||
occupant = Occupant(
|
||||
self,
|
||||
occupant_data,
|
||||
self.profile
|
||||
)
|
||||
self.occupants[occupant.nick] = occupant
|
||||
return occupant
|
||||
|
||||
def removeUser(self, occupant_data):
|
||||
"""Remove a user from the group list"""
|
||||
nick = occupant_data['nick']
|
||||
try:
|
||||
msg = msg.itervalues().next() # FIXME: tmp fix until message refactoring is finished (msg is now a dict)
|
||||
except StopIteration:
|
||||
log.warning(u"No message found (uid: {})".format(uid))
|
||||
msg = ''
|
||||
if self.type == C.CHAT_GROUP and target.resource and type_ != C.MESS_TYPE_GROUPCHAT:
|
||||
# we have a private message, we forward it to a private conversation widget
|
||||
chat_widget = self.getOrCreatePrivateWidget(target)
|
||||
chat_widget.messageNew(uid, timestamp, from_jid, target, msg, subject, type_, extra, profile)
|
||||
return
|
||||
|
||||
if type_ == C.MESS_TYPE_INFO:
|
||||
self.printInfo(msg, extra=extra)
|
||||
occupant = self.occupants.pop(nick)
|
||||
except KeyError:
|
||||
log.warning(u"Trying to remove an unknown occupant: {}".format(nick))
|
||||
else:
|
||||
nick = self._get_nick(from_jid)
|
||||
if msg.startswith('/me '):
|
||||
self.printInfo('* {} {}'.format(nick, msg[4:]), type_='me', extra=extra)
|
||||
else:
|
||||
# my_message is True if message comes from local user
|
||||
my_message = (from_jid.resource == self.nick) if self.type == C.CHAT_GROUP else (from_jid.bare == self.host.profiles[profile].whoami.bare)
|
||||
self.printMessage(nick, my_message, msg, timestamp, extra, profile)
|
||||
# FIXME: to be checked/removed after message refactoring
|
||||
# if timestamp:
|
||||
self.afterHistoryPrint()
|
||||
return occupant
|
||||
|
||||
def printMessage(self, nick, my_message, message, timestamp, extra=None, profile=C.PROF_KEY_NONE):
|
||||
"""Print message in chat window.
|
||||
def setUserNick(self, nick):
|
||||
"""Set the nick of the user, usefull for e.g. change the color of the user"""
|
||||
self.nick = nick
|
||||
|
||||
@param nick (unicode): author nick
|
||||
@param my_message (boolean): True if profile is the author
|
||||
@param message (unicode): message content
|
||||
@param extra (dict): extra data
|
||||
def changeUserNick(self, old_nick, new_nick):
|
||||
"""Change nick of a user in group list"""
|
||||
self.printInfo("%s is now known as %s" % (old_nick, new_nick))
|
||||
|
||||
## Messages ##
|
||||
|
||||
def manageMessage(self, entity, mess_type):
|
||||
"""Tell if this chat widget manage an entity and message type couple
|
||||
|
||||
@param entity (jid.JID): (full) jid of the sending entity
|
||||
@param mess_type (str): message type as given by messageNew
|
||||
@return (bool): True if this Chat Widget manage this couple
|
||||
"""
|
||||
# FIXME: check/remove this if necessary (message refactoring)
|
||||
# if not timestamp:
|
||||
# # XXX: do not send notifications for each line of the history being displayed
|
||||
# # FIXME: this must be changed in the future if the timestamp is passed with
|
||||
# # all messages and not only with the messages coming from the history.
|
||||
self.notify(nick, message)
|
||||
if self.type == C.CHAT_GROUP:
|
||||
if mess_type in (C.MESS_TYPE_GROUPCHAT, C.MESS_TYPE_INFO) and self.target == entity.bare:
|
||||
return True
|
||||
else:
|
||||
if mess_type != C.MESS_TYPE_GROUPCHAT and entity in self.targets:
|
||||
return True
|
||||
return False
|
||||
|
||||
def printInfo(self, msg, type_='normal', extra=None):
|
||||
"""Print general info.
|
||||
def updateHistory(self, size=C.HISTORY_LIMIT_DEFAULT, search='', profile='@NONE@'):
|
||||
"""Called when history need to be recreated
|
||||
|
||||
@param msg (unicode): message to print
|
||||
@param type_ (unicode):
|
||||
- 'normal': general info like "toto has joined the room"
|
||||
- 'me': "/me" information like "/me clenches his fist" ==> "toto clenches his fist"
|
||||
@param extra (dict): message data
|
||||
Remove all message from history then call historyPrint
|
||||
Must probably be overriden by frontend to clear widget
|
||||
@param size (int): number of messages
|
||||
@param search (str): pattern to filter the history results
|
||||
@param profile (str): %(doc_profile)s
|
||||
"""
|
||||
self.notify(msg=msg)
|
||||
self._locked = True
|
||||
self.messages.clear()
|
||||
self.historyPrint(size, search, profile)
|
||||
|
||||
def _onHistoryPrinted(self):
|
||||
"""Method called when history is printed (or failed)
|
||||
|
||||
unlock the widget, and can be used to refresh or scroll down
|
||||
the focus after the history is printed
|
||||
"""
|
||||
self._locked = False
|
||||
for data in self._cache:
|
||||
self.messageNew(*data)
|
||||
|
||||
def historyPrint(self, size=C.HISTORY_LIMIT_DEFAULT, search='', profile='@NONE@'):
|
||||
"""Print the current history
|
||||
|
||||
@param size (int): number of messages
|
||||
@param search (str): pattern to filter the history results
|
||||
@param profile (str): %(doc_profile)s
|
||||
"""
|
||||
if size == 0:
|
||||
log.debug(u"Empty history requested, skipping")
|
||||
self._onHistoryPrinted()
|
||||
return
|
||||
log_msg = _(u"now we print the history")
|
||||
if size != C.HISTORY_LIMIT_DEFAULT:
|
||||
log_msg += _(u" ({} messages)".format(size))
|
||||
log.debug(log_msg)
|
||||
|
||||
target = self.target.bare
|
||||
|
||||
def _historyGetCb(history):
|
||||
# day_format = "%A, %d %b %Y" # to display the day change
|
||||
# previous_day = datetime.now().strftime(day_format)
|
||||
# message_day = datetime.fromtimestamp(timestamp).strftime(self.day_format)
|
||||
# if previous_day != message_day:
|
||||
# self.printDayChange(message_day)
|
||||
# previous_day = message_day
|
||||
for data in history:
|
||||
uid, timestamp, from_jid, to_jid, message, subject, type_, extra = data
|
||||
from_jid = jid.JID(from_jid)
|
||||
to_jid = jid.JID(to_jid)
|
||||
# if ((self.type == C.CHAT_GROUP and type_ != C.MESS_TYPE_GROUPCHAT) or
|
||||
# (self.type == C.CHAT_ONE2ONE and type_ == C.MESS_TYPE_GROUPCHAT)):
|
||||
# continue
|
||||
self.messages[uid] = Message(self, uid, timestamp, from_jid, to_jid, message, subject, type_, extra, profile)
|
||||
self._onHistoryPrinted()
|
||||
|
||||
def _historyGetEb(err):
|
||||
log.error(_(u"Can't get history"))
|
||||
self._onHistoryPrinted()
|
||||
|
||||
self.host.bridge.historyGet(unicode(self.host.profiles[profile].whoami.bare), unicode(target), size, True, search, profile, callback=_historyGetCb, errback=_historyGetEb)
|
||||
|
||||
def messageNew(self, uid, timestamp, from_jid, to_jid, msg, subject, type_, extra, profile):
|
||||
log.debug(u"messageNew ==> {}".format((uid, timestamp, from_jid, to_jid, msg, subject, type_, extra, profile)))
|
||||
if self._locked:
|
||||
self._cache.append(uid, timestamp, from_jid, to_jid, msg, subject, type_, extra, profile)
|
||||
return
|
||||
if self.type == C.CHAT_GROUP:
|
||||
if to_jid.resource and type_ != C.MESS_TYPE_GROUPCHAT:
|
||||
# we have a private message, we forward it to a private conversation widget
|
||||
chat_widget = self.getOrCreatePrivateWidget(to_jid)
|
||||
chat_widget.messageNew(uid, timestamp, from_jid, to_jid, msg, subject, type_, extra, profile)
|
||||
return
|
||||
if type_ == C.MESS_TYPE_INFO:
|
||||
try:
|
||||
info_type = extra['info_type']
|
||||
except KeyError:
|
||||
pass
|
||||
else:
|
||||
user_data = {k[5:]:v for k,v in extra.iteritems() if k.startswith('user_')}
|
||||
if info_type == ROOM_USER_JOINED:
|
||||
self.addUser(user_data)
|
||||
elif info_type == ROOM_USER_LEFT:
|
||||
self.removeUser(user_data)
|
||||
|
||||
message = Message(self, uid, timestamp, from_jid, to_jid, msg, subject, type_, extra, profile)
|
||||
self.messages[uid] = message
|
||||
|
||||
if 'received_timestamp' in extra:
|
||||
log.warning(u"Delayed message received after history, this should not happen")
|
||||
self.createMessage(message)
|
||||
|
||||
def createMessage(self, message, append=False):
|
||||
"""Must be implemented by frontend to create and show a new message widget
|
||||
|
||||
This is only called on messageNew, not on history.
|
||||
You need to override historyPrint to handle the later
|
||||
@param message(Message): message data
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
def notify(self, contact="somebody", msg=""):
|
||||
"""Notify the user of a new message if the frontend doesn't have the focus.
|
||||
|
|
@ -246,6 +346,7 @@ class QuickChat(quick_widgets.QuickWidget):
|
|||
@param contact (unicode): contact who wrote to the users
|
||||
@param msg (unicode): the message that has been received
|
||||
"""
|
||||
# FIXME: not called anymore after refactoring
|
||||
raise NotImplemented
|
||||
|
||||
def printDayChange(self, day):
|
||||
|
|
@ -253,21 +354,16 @@ class QuickChat(quick_widgets.QuickWidget):
|
|||
|
||||
@param day(unicode): day to display (or not if this method is not overwritten)
|
||||
"""
|
||||
# FIXME: not called anymore after refactoring
|
||||
pass
|
||||
|
||||
def getEntityStates(self, entity):
|
||||
"""Retrieve states for an entity.
|
||||
## Room ##
|
||||
|
||||
@param entity (jid.JID): entity
|
||||
@return: OrderedDict{unicode: unicode}
|
||||
"""
|
||||
states = OrderedDict()
|
||||
clist = self.host.contact_lists[self.profile]
|
||||
for key in self.visible_states:
|
||||
value = clist.getCache(entity, key)
|
||||
if value:
|
||||
states[key] = value
|
||||
return states
|
||||
def setSubject(self, subject):
|
||||
"""Set title for a group chat"""
|
||||
self.subject = subject
|
||||
if self.type != C.CHAT_GROUP:
|
||||
raise exceptions.InternalError("trying to set subject for a non group chat window")
|
||||
|
||||
def addGamePanel(self, widget):
|
||||
"""Insert a game panel to this Chat dialog.
|
||||
|
|
|
|||
Loading…
Reference in a new issue