src/message_control.py

   1 # -*- coding:utf-8 -*-
   2 ## src/message_control.py
   3 ##
   4 ## Copyright (C) 2006 Dimitur Kirov <dkirov AT gmail.com>
   5 ##                    Nikos Kouremenos <kourem AT gmail.com>
   6 ## Copyright (C) 2006-2007 Jean-Marie Traissard <jim AT lapin.org>
   7 ##                         Travis Shirk <travis AT pobox.com>
   8 ## Copyright (C) 2006-2010 Yann Leboulanger <asterix AT lagaule.org>
   9 ## Copyright (C) 2007 Julien Pivotto <roidelapluie AT gmail.com>
  10 ##                    Stephan Erb <steve-e AT h3c.de>
  11 ## Copyright (C) 2007-2008 Brendan Taylor <whateley AT gmail.com>
  12 ## Copyright (C) 2008 Jonathan Schleifer <js-gajim AT webkeks.org>
  13 ##
  14 ## This file is part of Gajim.
  15 ##
  16 ## Gajim is free software; you can redistribute it and/or modify
  17 ## it under the terms of the GNU General Public License as published
  18 ## by the Free Software Foundation; version 3 only.
  19 ##
  20 ## Gajim is distributed in the hope that it will be useful,
  21 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  23 ## GNU General Public License for more details.
  24 ##
  25 ## You should have received a copy of the GNU General Public License
  26 ## along with Gajim. If not, see <http://www.gnu.org/licenses/>.
  27 ##
  28
  29 import gtkgui_helpers
  30
  31 from common import gajim
  32 from common import helpers
  33 from common import ged
  34 from common.stanza_session import EncryptedStanzaSession, ArchivingStanzaSession
  35
  36 # Derived types MUST register their type IDs here if custom behavor is required
  37 TYPE_CHAT = 'chat'
  38 TYPE_GC = 'gc'
  39 TYPE_PM = 'pm'
  40
  41 ####################
  42
  43 class MessageControl(object):
  44     """
  45     An abstract base widget that can embed in the gtk.Notebook of a
  46     MessageWindow
  47     """
  48
  49     def __init__(self, type_id, parent_win, widget_name, contact, account, resource = None):
  50         # dict { cb id : widget}
  51         # keep all registered callbacks of widgets, created by self.xml
  52         self.handlers = {}
  53         self.type_id = type_id
  54         self.parent_win = parent_win
  55         self.widget_name = widget_name
  56         self.contact = contact
  57         self.account = account
  58         self.hide_chat_buttons = False
  59         self.resource = resource
  60
  61         self.session = None
  62
  63         gajim.last_message_time[self.account][self.get_full_jid()] = 0
  64
  65         self.xml = gtkgui_helpers.get_gtk_builder('%s.ui' % widget_name)
  66         self.widget = self.xml.get_object('%s_hbox' % widget_name)
  67
  68         gajim.ged.register_event_handler('message-outgoing', ged.OUT_GUI1,
  69             self._nec_message_outgoing)
  70
  71     def get_full_jid(self):
  72         fjid = self.contact.jid
  73         if self.resource:
  74             fjid += '/' + self.resource
  75         return fjid
  76
  77     def set_control_active(self, state):
  78         """
  79         Called when the control becomes active (state is True) or inactive (state
  80         is False)
  81         """
  82         pass  # Derived classes MUST implement this method
  83
  84     def minimizable(self):
  85         """
  86         Called to check if control can be minimized
  87
  88         Derived classes MAY implement this.
  89         """
  90         return False
  91
  92     def safe_shutdown(self):
  93         """
  94         Called to check if control can be closed without loosing data.
  95         returns True if control can be closed safely else False
  96
  97         Derived classes MAY implement this.
  98         """
  99         return True
 100
 101     def allow_shutdown(self, method, on_response_yes, on_response_no,
 102                     on_response_minimize):
 103         """
 104         Called to check is a control is allowed to shutdown.
 105         If a control is not in a suitable shutdown state this method
 106         should call on_response_no, else on_response_yes or
 107         on_response_minimize
 108
 109         Derived classes MAY implement this.
 110         """
 111         on_response_yes(self)
 112
 113     def shutdown(self):
 114         """
 115         Derived classes MUST implement this
 116         """
 117         gajim.ged.remove_event_handler('message-outgoing', ged.OUT_GUI1,
 118             self._nec_message_outgoing)
 119
 120     def repaint_themed_widgets(self):
 121         """
 122         Derived classes SHOULD implement this
 123         """
 124         pass
 125
 126     def update_ui(self):
 127         """
 128         Derived classes SHOULD implement this
 129         """
 130         pass
 131
 132     def toggle_emoticons(self):
 133         """
 134         Derived classes MAY implement this
 135         """
 136         pass
 137
 138     def update_font(self):
 139         """
 140         Derived classes SHOULD implement this
 141         """
 142         pass
 143
 144     def update_tags(self):
 145         """
 146         Derived classes SHOULD implement this
 147         """
 148         pass
 149
 150     def get_tab_label(self, chatstate):
 151         """
 152         Return a suitable tab label string. Returns a tuple such as: (label_str,
 153         color) either of which can be None if chatstate is given that means we
 154         have HE SENT US a chatstate and we want it displayed
 155
 156         Derivded classes MUST implement this.
 157         """
 158         # Return a markup'd label and optional gtk.Color in a tupple like:
 159         # return (label_str, None)
 160         pass
 161
 162     def get_tab_image(self, count_unread=True):
 163         # Return a suitable tab image for display.
 164         # None clears any current label.
 165         return None
 166
 167     def prepare_context_menu(self):
 168         """
 169         Derived classes SHOULD implement this
 170         """
 171         return None
 172
 173     def chat_buttons_set_visible(self, state):
 174         """
 175         Derived classes MAY implement this
 176         """
 177         self.hide_chat_buttons = state
 178
 179     def got_connected(self):
 180         pass
 181
 182     def got_disconnected(self):
 183         pass
 184
 185     def get_specific_unread(self):
 186         return len(gajim.events.get_events(self.account,
 187                 self.contact.jid))
 188
 189     def set_session(self, session):
 190         oldsession = None
 191         if hasattr(self, 'session'):
 192             oldsession = self.session
 193
 194         if oldsession and session == oldsession:
 195             return
 196
 197         self.session = session
 198
 199         if session:
 200             session.control = self
 201
 202         if oldsession:
 203             oldsession.control = None
 204
 205             jid = self.contact.jid
 206             if self.resource:
 207                 jid += '/' + self.resource
 208
 209         crypto_changed = bool(session and isinstance(session,
 210                 EncryptedStanzaSession) and session.enable_encryption) != \
 211                 bool(oldsession and isinstance(oldsession,
 212                 EncryptedStanzaSession) and oldsession.enable_encryption)
 213
 214         archiving_changed = bool(session and isinstance(session,
 215             ArchivingStanzaSession) and session.archiving) != \
 216             bool(oldsession and isinstance(oldsession,
 217             ArchivingStanzaSession) and oldsession.archiving)
 218
 219         if crypto_changed or archiving_changed:
 220             self.print_session_details()
 221
 222     def _nec_message_outgoing(self, obj):
 223         # Send the given message to the active tab.
 224         # Doesn't return None if error
 225         if obj.account != self.account:
 226             return
 227
 228         obj.jid = self.contact.jid
 229         obj.message = helpers.remove_invalid_xml_chars(obj.message)
 230         obj.original_message = obj.message
 231
 232         conn = gajim.connections[self.account]
 233
 234         if not self.session:
 235             if not obj.resource:
 236                 if self.resource:
 237                     obj.resource = self.resource
 238                 else:
 239                     obj.resource = self.contact.resource
 240             sess = conn.find_controlless_session(obj.jid, resource=obj.resource)
 241
 242             if self.resource:
 243                 obj.jid += '/' + self.resource
 244
 245             if not sess:
 246                 if self.type_id == TYPE_PM:
 247                     sess = conn.make_new_session(obj.jid, type_='pm')
 248                 else:
 249                     sess = conn.make_new_session(obj.jid)
 250
 251             self.set_session(sess)
 252
 253         obj.session = self.session