1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
## 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 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
new_key = None
if session:
session.control = self
new_key = session.thread_id
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):
# 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:
sess = conn.make_new_session(jid)
self.set_session(sess)
# Send and update history
return 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)
# vim: se ts=3:
|
