2 # Copyright (c) 2008 INdT - Instituto Nokia de Tecnologia
4 # This file is part of python-purple.
6 # python-purple is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # python-purple is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
22 cdef extern from "c_purple.h":
23 glib.guint glib_input_add(glib.gint fd, eventloop.PurpleInputCondition condition, eventloop.PurpleInputFunction function, glib.gpointer data)
27 cdef glib.GHashTable *c_ui_info
32 cdef char *c_ui_version
33 cdef char *c_ui_website
34 cdef char *c_ui_dev_website
36 cdef account.PurpleAccountUiOps c_account_ui_ops
37 cdef blist.PurpleBlistUiOps c_blist_ui_ops
38 cdef connection.PurpleConnectionUiOps c_conn_ui_ops
39 cdef conversation.PurpleConversationUiOps c_conv_ui_ops
40 cdef core.PurpleCoreUiOps c_core_ui_ops
41 cdef eventloop.PurpleEventLoopUiOps c_eventloop_ui_ops
42 #cdef ft.PurpleXferUiOps c_ft_ui_ops
43 cdef notify.PurpleNotifyUiOps c_notify_ui_ops
44 #cdef privacy.PurplePrivacyUiOps c_privacy_ui_ops
45 cdef request.PurpleRequestUiOps c_request_ui_ops
46 #cdef roomlist.PurpleRoomlistUiOps c_rlist_ui_ops
48 include "account_cbs.pxd"
49 include "blist_cbs.pxd"
50 include "connection_cbs.pxd"
51 include "conversation_cbs.pxd"
52 #include "xfer_cbs.pxd"
53 include "notify_cbs.pxd"
54 #include "privacy_cbs.pxd"
55 include "request_cbs.pxd"
56 #include "roomlist_cbs.pxd"
57 include "signal_cbs.pxd"
64 @param ui_name ID of the UI using the purple.
65 This should be a unique ID, registered with the purple team.
66 @param ui_version UI version.
67 @param ui_website UI website.
68 @param ui_dev_website UI development website.
69 @param debug_enabled True to enable debug messages.
70 @param default_path Custom settings directory
74 def __init__(self, ui_name, ui_version, ui_website, ui_dev_website, \
75 debug_enabled=None, default_path=None):
80 global c_ui_dev_website
83 c_ui_version = ui_version
84 c_ui_website = ui_website
85 c_ui_dev_website = ui_dev_website
88 debug.purple_debug_set_enabled(debug_enabled)
91 util.purple_util_set_user_dir(default_path)
93 # adds glib iteration inside ecore main loop
94 ecore.timer_add(0.001, self.__glib_iteration_when_idle)
97 core.purple_core_quit()
99 def __get_ui_name(self):
100 '''Returns the UI name.
106 return str(c_ui_name)
107 ui_name = property(__get_ui_name)
109 cdef void __core_ui_ops_ui_prefs_init(self):
110 debug.purple_debug_info("core_ui_ops", "%s", "ui_prefs_init\n")
111 prefs.purple_prefs_load()
113 prefs.purple_prefs_add_none("/carman")
115 cdef void __core_ui_ops_debug_init(self):
116 debug.purple_debug_info("core_ui_ops", "%s", "debug_ui_init\n")
119 cdef void __core_ui_ops_ui_init(self):
120 debug.purple_debug_info("core_ui_ops", "%s", "ui_init\n")
122 account.purple_accounts_set_ui_ops(&c_account_ui_ops)
123 connection.purple_connections_set_ui_ops(&c_conn_ui_ops)
124 blist.purple_blist_set_ui_ops(&c_blist_ui_ops)
125 conversation.purple_conversations_set_ui_ops(&c_conv_ui_ops)
126 notify.purple_notify_set_ui_ops(&c_notify_ui_ops)
127 #privacy.purple_privacy_set_ui_ops(&c_privacy_ui_ops)
128 request.purple_request_set_ui_ops(&c_request_ui_ops)
129 #ft.purple_xfers_set_ui_ops(&c_ft_ui_ops)
130 #roomlist.purple_roomlist_set_ui_ops(&c_rlist_ui_ops)
132 cdef void __core_ui_ops_quit(self):
133 debug.purple_debug_info("core_ui_ops", "%s", "quit\n")
135 account.purple_accounts_set_ui_ops(NULL)
136 connection.purple_connections_set_ui_ops(NULL)
137 blist.purple_blist_set_ui_ops(NULL)
138 conversation.purple_conversations_set_ui_ops(NULL)
139 notify.purple_notify_set_ui_ops(NULL)
140 #privacy.purple_privacy_set_ui_ops(NULL)
141 request.purple_request_set_ui_ops(NULL)
142 #ft.purple_xfers_set_ui_ops(NULL)
143 #roomlist.purple_roomlist_set_ui_ops(NULL)
146 glib.g_hash_table_destroy(<glib.GHashTable *> self.c_ui_info)
148 cdef glib.GHashTable *__core_ui_ops_get_ui_info(self):
153 global c_ui_dev_website
155 if c_ui_info == NULL:
156 c_ui_info = glib.g_hash_table_new(glib.g_str_hash, \
159 glib.g_hash_table_insert(c_ui_info, "name", c_ui_name)
160 glib.g_hash_table_insert(c_ui_info, "version", c_ui_version)
161 glib.g_hash_table_insert(c_ui_info, "website", c_ui_website)
162 glib.g_hash_table_insert(c_ui_info, "dev_website", c_ui_dev_website)
165 def __glib_iteration_when_idle(self):
166 glib.g_main_context_iteration(NULL, False)
169 def purple_init(self):
170 '''Initializes the purple.
172 This will setup preferences for all the core subsystems.
177 c_account_ui_ops.notify_added = notify_added
178 c_account_ui_ops.status_changed = status_changed
179 c_account_ui_ops.request_add = request_add
180 c_account_ui_ops.request_authorize = request_authorize
181 c_account_ui_ops.close_account_request = close_account_request
183 c_blist_ui_ops.new_list = new_list
184 c_blist_ui_ops.new_node = new_node
185 c_blist_ui_ops.show = show
186 c_blist_ui_ops.update = update
187 c_blist_ui_ops.remove = remove
188 c_blist_ui_ops.destroy = destroy
189 c_blist_ui_ops.set_visible = set_visible
190 c_blist_ui_ops.request_add_buddy = request_add_buddy
191 c_blist_ui_ops.request_add_chat = request_add_chat
192 c_blist_ui_ops.request_add_group = request_add_group
194 c_conn_ui_ops.connect_progress = connect_progress
195 c_conn_ui_ops.connected = connected
196 c_conn_ui_ops.disconnected = disconnected
197 c_conn_ui_ops.notice = notice
198 c_conn_ui_ops.report_disconnect = report_disconnect
199 c_conn_ui_ops.network_connected = network_connected
200 c_conn_ui_ops.network_disconnected = network_disconnected
201 c_conn_ui_ops.report_disconnect_reason = report_disconnect_reason
203 c_conv_ui_ops.create_conversation = create_conversation
204 c_conv_ui_ops.destroy_conversation = destroy_conversation
205 c_conv_ui_ops.write_chat = write_chat
206 c_conv_ui_ops.write_im = write_im
207 c_conv_ui_ops.write_conv = write_conv
208 c_conv_ui_ops.chat_add_users = chat_add_users
209 c_conv_ui_ops.chat_rename_user = chat_rename_user
210 c_conv_ui_ops.chat_remove_users = chat_remove_users
211 c_conv_ui_ops.chat_update_user = chat_update_user
212 c_conv_ui_ops.present = present
213 c_conv_ui_ops.has_focus = has_focus
214 c_conv_ui_ops.custom_smiley_add = custom_smiley_add
215 c_conv_ui_ops.custom_smiley_write = custom_smiley_write
216 c_conv_ui_ops.custom_smiley_close = custom_smiley_close
217 c_conv_ui_ops.send_confirm = send_confirm
219 c_notify_ui_ops.notify_message = notify_message
220 c_notify_ui_ops.notify_email = notify_email
221 c_notify_ui_ops.notify_emails = notify_emails
222 c_notify_ui_ops.notify_formatted = notify_formatted
223 c_notify_ui_ops.notify_searchresults = notify_searchresults
224 c_notify_ui_ops.notify_searchresults_new_rows = notify_searchresults_new_rows
225 c_notify_ui_ops.notify_userinfo = notify_userinfo
226 c_notify_ui_ops.notify_uri = notify_uri
227 c_notify_ui_ops.close_notify = close_notify
229 c_request_ui_ops.request_input = request_input
230 c_request_ui_ops.request_choice = request_choice
231 c_request_ui_ops.request_action = request_action
232 c_request_ui_ops.request_fields = request_fields
233 c_request_ui_ops.request_file = request_file
234 c_request_ui_ops.close_request = close_request
235 c_request_ui_ops.request_folder = request_folder
237 c_core_ui_ops.ui_prefs_init = <void (*)()> self.__core_ui_ops_ui_prefs_init
238 c_core_ui_ops.debug_ui_init = <void (*)()> self.__core_ui_ops_debug_init
239 c_core_ui_ops.ui_init = <void (*)()> self.__core_ui_ops_ui_init
240 c_core_ui_ops.quit = <void (*)()> self.__core_ui_ops_quit
241 c_core_ui_ops.get_ui_info = <glib.GHashTable* (*)()> self.__core_ui_ops_get_ui_info
243 c_eventloop_ui_ops.timeout_add = glib.g_timeout_add
244 c_eventloop_ui_ops.timeout_remove = glib.g_source_remove
245 c_eventloop_ui_ops.input_add = glib_input_add
246 c_eventloop_ui_ops.input_remove = glib.g_source_remove
247 c_eventloop_ui_ops.input_get_error = NULL
248 c_eventloop_ui_ops.timeout_add_seconds = NULL
250 core.purple_core_set_ui_ops(&c_core_ui_ops)
251 eventloop.purple_eventloop_set_ui_ops(&c_eventloop_ui_ops)
253 # initialize purple core
254 ret = core.purple_core_init(c_ui_name)
256 debug.purple_debug_fatal("main", "%s", "libpurple " \
257 "initialization failed.\n")
260 # check if there is another instance of libpurple running
261 if core.purple_core_ensure_single_instance() == False:
262 debug.purple_debug_fatal("main", "%s", "Another instance of " \
263 "libpurple is already running.\n")
264 core.purple_core_quit()
267 # create and load the buddy list
268 blist.purple_set_blist(blist.purple_blist_new())
269 blist.purple_blist_load()
272 pounce.purple_pounces_load()
276 def add_callback(self, type, name, callback):
277 '''Adds a callback with given name inside callback's type.
279 @param type Callback type (e.g. "account")
280 @param name Callback name (e.g. "notify-added")
281 @param callback Callback to be called
286 global connection_cbs
287 global conversation_cbs
291 { "account": account_cbs,
293 "connection": connection_cbs,
294 "conversation": conversation_cbs,
295 "notify": notify_cbs,
296 "request": request_cbs }[type][name] = callback
298 def signal_connect(self, name=None, cb=None):
299 '''Connects a signal handler to a signal for a particular object.
300 Take care not to register a handler function twice. Purple will
301 not correct any mistakes for you in this area.
303 @param name Name of the signal to connect.
304 @param cb Callback function.
308 cdef plugin.PurplePlugin *jabber
313 jabber = prpl.purple_find_prpl("prpl-jabber")
318 signal_cbs[name] = cb
320 if name == "signed-on":
321 signals.purple_signal_connect(
322 connection.purple_connections_get_handle(),
323 "signed-on", &handle,
324 <signals.PurpleCallback> signal_signed_on_cb, NULL)
325 elif name == "signed-off":
326 signals.purple_signal_connect(
327 connection.purple_connections_get_handle(),
328 "signed-off", &handle,
329 <signals.PurpleCallback> signal_signed_off_cb, NULL)
330 elif name == "connection-error":
331 signals.purple_signal_connect(
332 connection.purple_connections_get_handle(),
333 "connection-error", &handle,
334 <signals.PurpleCallback> signal_connection_error_cb, NULL)
335 elif name == "buddy-signed-on":
336 signals.purple_signal_connect(
337 blist.purple_blist_get_handle(),
338 "buddy-signed-on", &handle,
339 <signals.PurpleCallback> signal_buddy_signed_on_cb, NULL)
340 elif name == "buddy-signed-off":
341 signals.purple_signal_connect(
342 blist.purple_blist_get_handle(),
343 "buddy-signed-off", &handle,
344 <signals.PurpleCallback> signal_buddy_signed_off_cb, NULL)
345 elif name == "receiving-im-msg":
346 signals.purple_signal_connect(
347 conversation.purple_conversations_get_handle(),
348 "receiving-im-msg", &handle,
349 <signals.PurpleCallback> signal_receiving_im_msg_cb, NULL)
350 elif name == "jabber-receiving-xmlnode":
351 signals.purple_signal_connect(
352 jabber, "jabber-receiving-xmlnode", &handle,
353 <signals.PurpleCallback> jabber_receiving_xmlnode_cb, NULL)
355 def accounts_get_all(self):
356 '''Returns a list of all accounts.
358 @return A list of all accounts.
361 cdef glib.GList *iter
362 cdef account.PurpleAccount *acc
364 cdef char *protocol_id
366 iter = account.purple_accounts_get_all()
370 acc = <account.PurpleAccount *> iter.data
372 if <account.PurpleAccount *>acc:
373 username = <char *> account.purple_account_get_username(acc)
374 protocol_id = <char *> account.purple_account_get_protocol_id(acc)
376 if username != NULL and protocol_id != NULL:
377 account_list.append(Account(username, \
378 Protocol(protocol_id), self))
383 def accounts_get_all_active(self):
384 '''Returns a list of all enabled accounts.
386 @return A list of all enabled accounts.
389 cdef glib.GList *iter
390 cdef account.PurpleAccount *acc
392 cdef char *protocol_id
394 #FIXME: The list is owned by the caller, and must be g_list_free()d
395 # to avoid leaking the nodes.
397 iter = account.purple_accounts_get_all_active()
401 acc = <account.PurpleAccount *> iter.data
403 if <account.PurpleAccount *>acc:
404 username = <char *> account.purple_account_get_username(acc)
405 protocol_id = <char *> account.purple_account_get_protocol_id(acc)
407 if username != NULL and protocol_id != NULL:
408 account_list.append(Account(username, \
409 Protocol(protocol_id), self))
414 def protocols_get_all(self):
415 '''Returns a list of all protocols.
417 @return A list of all protocols.
420 cdef glib.GList *iter
421 cdef plugin.PurplePlugin *pp
423 iter = plugin.purple_plugins_get_protocols()
426 pp = <plugin.PurplePlugin*> iter.data
427 if pp.info and pp.info.name:
428 protocol_list.append(Protocol(pp.info.id))
432 def call_action(self, i):
435 include "protocol.pyx"
436 #include "plugin.pyx"
438 #include "protocol.pyx"
439 include "account.pyx"
441 #include "connection.pyx"
442 include "conversation.pyx"