gajim-plural/src/message_control.py

206 lines
6.0 KiB
Python

# -*- coding:utf-8 -*-
## src/message_control.py
##
## Copyright (C) 2006 Dimitur Kirov <dkirov AT gmail.com>
## Nikos Kouremenos <kourem AT gmail.com>
## Copyright (C) 2006-2007 Jean-Marie Traissard <jim AT lapin.org>
## Travis Shirk <travis AT pobox.com>
## Copyright (C) 2006-2008 Yann Leboulanger <asterix AT lagaule.org>
## Copyright (C) 2007 Julien Pivotto <roidelapluie AT gmail.com>
## Stephan Erb <steve-e AT h3c.de>
## Copyright (C) 2007-2008 Brendan Taylor <whateley AT gmail.com>
## Copyright (C) 2008 Jonathan Schleifer <js-gajim AT webkeks.org>
##
## This file is part of Gajim.
##
## Gajim is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published
## by the Free Software Foundation; version 3 only.
##
## Gajim is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Gajim. If not, see <http://www.gnu.org/licenses/>.
##
import gtkgui_helpers
from common import gajim
from common import helpers
# Derived types MUST register their type IDs here if custom behavor is required
TYPE_CHAT = 'chat'
TYPE_GC = 'gc'
TYPE_PM = 'pm'
####################
class MessageControl:
'''An abstract base widget that can embed in the gtk.Notebook of a MessageWindow'''
def __init__(self, type_id, parent_win, widget_name, contact, account, resource = None):
# dict { cb id : widget}
# keep all registered callbacks of widgets, created by self.xml
self.handlers = {}
self.type_id = type_id
self.parent_win = parent_win
self.widget_name = widget_name
self.contact = contact
self.account = account
self.hide_chat_buttons = False
self.resource = resource
self.session = None
gajim.last_message_time[self.account][self.get_full_jid()] = 0
self.xml = gtkgui_helpers.get_glade('message_window.glade', widget_name)
self.widget = self.xml.get_widget(widget_name)
def get_full_jid(self):
fjid = self.contact.jid
if self.resource:
fjid += '/' + self.resource
return fjid
def set_control_active(self, state):
'''Called when the control becomes active (state is True)
or inactive (state is False)'''
pass # Derived classes MUST implement this method
def minimizable(self):
'''Called to check if control can be minimized'''
# NOTE: Derived classes MAY implement this
return False
def safe_shutdown(self):
'''Called to check if control can be closed without loosing data.
returns True if control can be closed safely else False'''
# NOTE: Derived classes MAY implement this
return True
def allow_shutdown(self, method, on_response_yes, on_response_no,
on_response_minimize):
'''Called to check is a control is allowed to shutdown.
If a control is not in a suitable shutdown state this method
should call on_response_no, else on_response_yes or
on_response_minimize '''
# NOTE: Derived classes MAY implement this
on_response_yes(self)
def shutdown(self):
# NOTE: Derived classes MUST implement this
pass
def repaint_themed_widgets(self):
pass # NOTE: Derived classes SHOULD implement this
def update_ui(self):
pass # NOTE: Derived classes SHOULD implement this
def toggle_emoticons(self):
pass # NOTE: Derived classes MAY implement this
def update_font(self):
pass # NOTE: Derived classes SHOULD implement this
def update_tags(self):
pass # NOTE: Derived classes SHOULD implement this
def get_tab_label(self, chatstate):
'''Return a suitable tab label string. Returns a tuple such as:
(label_str, color) either of which can be None
if chatstate is given that means we have HE SENT US a chatstate and
we want it displayed'''
# NOTE: Derived classes MUST implement this
# Return a markup'd label and optional gtk.Color in a tupple like:
#return (label_str, None)
pass
def get_tab_image(self):
# Return a suitable tab image for display.
# None clears any current label.
return None
def prepare_context_menu(self):
# NOTE: Derived classes SHOULD implement this
return None
def chat_buttons_set_visible(self, state):
# NOTE: Derived classes MAY implement this
self.hide_chat_buttons = state
def got_connected(self):
pass
def got_disconnected(self):
pass
def get_specific_unread(self):
return len(gajim.events.get_events(self.account,
self.contact.jid))
def set_session(self, session):
oldsession = None
if hasattr(self, 'session'):
oldsession = self.session
if oldsession and session == oldsession:
return
self.session = session
if session:
session.control = self
if oldsession:
oldsession.control = None
jid = self.contact.jid
if self.resource:
jid += '/' + self.resource
crypto_changed = bool(session and session.enable_encryption) != \
bool(oldsession and oldsession.enable_encryption)
if crypto_changed:
self.print_esession_details()
def send_message(self, message, keyID='', type_='chat', chatstate=None,
msg_id=None, composing_xep=None, resource=None, user_nick=None, xhtml=None,
callback=None, callback_args=[]):
# Send the given message to the active tab.
# Doesn't return None if error
jid = self.contact.jid
message = helpers.remove_invalid_xml_chars(message)
original_message = message
conn = gajim.connections[self.account]
if not self.session:
sess = conn.find_controlless_session(jid)
if self.resource:
jid += '/' + self.resource
if not sess:
if self.type_id == TYPE_PM:
sess = conn.make_new_session(jid, type_='pm')
else:
sess = conn.make_new_session(jid)
self.set_session(sess)
# Send and update history
conn.send_message(jid, message, keyID, type_=type_, chatstate=chatstate,
msg_id=msg_id, composing_xep=composing_xep, resource=self.resource,
user_nick=user_nick, session=self.session,
original_message=original_message, xhtml=xhtml, callback=callback,
callback_args=callback_args)
# vim: se ts=3: