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 # libpurple's built-in DNS resolution forks processes to perform
94 # blocking lookups without blocking the main process. It does not
95 # handle SIGCHLD itself, so if the UI does not you quickly get an army
96 # of zombie subprocesses marching around.
97 signal.signal(signal.SIGCHLD, signal.SIG_IGN)
100 core.purple_core_quit()
102 def __get_ui_name(self):
103 '''Returns the UI name.
109 return str(c_ui_name)
110 ui_name = property(__get_ui_name)
112 cdef void __core_ui_ops_ui_prefs_init(self):
113 debug.purple_debug_info("core_ui_ops", "%s", "ui_prefs_init\n")
114 prefs.purple_prefs_load()
116 prefs.purple_prefs_add_none("/carman")
118 cdef void __core_ui_ops_debug_init(self):
119 debug.purple_debug_info("core_ui_ops", "%s", "debug_ui_init\n")
122 cdef void __core_ui_ops_ui_init(self):
123 debug.purple_debug_info("core_ui_ops", "%s", "ui_init\n")
125 account.purple_accounts_set_ui_ops(&c_account_ui_ops)
126 connection.purple_connections_set_ui_ops(&c_conn_ui_ops)
127 blist.purple_blist_set_ui_ops(&c_blist_ui_ops)
128 conversation.purple_conversations_set_ui_ops(&c_conv_ui_ops)
129 notify.purple_notify_set_ui_ops(&c_notify_ui_ops)
130 #privacy.purple_privacy_set_ui_ops(&c_privacy_ui_ops)
131 request.purple_request_set_ui_ops(&c_request_ui_ops)
132 #ft.purple_xfers_set_ui_ops(&c_ft_ui_ops)
133 #roomlist.purple_roomlist_set_ui_ops(&c_rlist_ui_ops)
135 cdef void __core_ui_ops_quit(self):
136 debug.purple_debug_info("core_ui_ops", "%s", "quit\n")
138 account.purple_accounts_set_ui_ops(NULL)
139 connection.purple_connections_set_ui_ops(NULL)
140 blist.purple_blist_set_ui_ops(NULL)
141 conversation.purple_conversations_set_ui_ops(NULL)
142 notify.purple_notify_set_ui_ops(NULL)
143 #privacy.purple_privacy_set_ui_ops(NULL)
144 request.purple_request_set_ui_ops(NULL)
145 #ft.purple_xfers_set_ui_ops(NULL)
146 #roomlist.purple_roomlist_set_ui_ops(NULL)
149 glib.g_hash_table_destroy(<glib.GHashTable *> self.c_ui_info)
151 cdef glib.GHashTable *__core_ui_ops_get_ui_info(self):
156 global c_ui_dev_website
158 if c_ui_info == NULL:
159 c_ui_info = glib.g_hash_table_new(glib.g_str_hash, \
162 glib.g_hash_table_insert(c_ui_info, "name", c_ui_name)
163 glib.g_hash_table_insert(c_ui_info, "version", c_ui_version)
164 glib.g_hash_table_insert(c_ui_info, "website", c_ui_website)
165 glib.g_hash_table_insert(c_ui_info, "dev_website", c_ui_dev_website)
168 def purple_init(self):
169 '''Initializes the purple.
171 This will setup preferences for all the core subsystems.
176 c_account_ui_ops.notify_added = notify_added
177 c_account_ui_ops.status_changed = status_changed
178 c_account_ui_ops.request_add = request_add
179 c_account_ui_ops.request_authorize = request_authorize
180 c_account_ui_ops.close_account_request = close_account_request
182 c_blist_ui_ops.new_list = new_list
183 c_blist_ui_ops.new_node = new_node
184 c_blist_ui_ops.show = show
185 c_blist_ui_ops.update = update
186 c_blist_ui_ops.remove = remove
187 c_blist_ui_ops.destroy = destroy
188 c_blist_ui_ops.set_visible = set_visible
189 c_blist_ui_ops.request_add_buddy = request_add_buddy
190 c_blist_ui_ops.request_add_chat = request_add_chat
191 c_blist_ui_ops.request_add_group = request_add_group
193 c_conn_ui_ops.connect_progress = connect_progress
194 c_conn_ui_ops.connected = connected
195 c_conn_ui_ops.disconnected = disconnected
196 c_conn_ui_ops.notice = notice
197 c_conn_ui_ops.report_disconnect = report_disconnect
198 c_conn_ui_ops.network_connected = network_connected
199 c_conn_ui_ops.network_disconnected = network_disconnected
200 c_conn_ui_ops.report_disconnect_reason = report_disconnect_reason
202 c_conv_ui_ops.create_conversation = create_conversation
203 c_conv_ui_ops.destroy_conversation = destroy_conversation
204 c_conv_ui_ops.write_chat = write_chat
205 c_conv_ui_ops.write_im = write_im
206 c_conv_ui_ops.write_conv = write_conv
207 c_conv_ui_ops.chat_add_users = chat_add_users
208 c_conv_ui_ops.chat_rename_user = chat_rename_user
209 c_conv_ui_ops.chat_remove_users = chat_remove_users
210 c_conv_ui_ops.chat_update_user = chat_update_user
211 c_conv_ui_ops.present = present
212 c_conv_ui_ops.has_focus = has_focus
213 c_conv_ui_ops.custom_smiley_add = custom_smiley_add
214 c_conv_ui_ops.custom_smiley_write = custom_smiley_write
215 c_conv_ui_ops.custom_smiley_close = custom_smiley_close
216 c_conv_ui_ops.send_confirm = send_confirm
218 c_notify_ui_ops.notify_message = notify_message
219 c_notify_ui_ops.notify_email = notify_email
220 c_notify_ui_ops.notify_emails = notify_emails
221 c_notify_ui_ops.notify_formatted = notify_formatted
222 c_notify_ui_ops.notify_searchresults = notify_searchresults
223 c_notify_ui_ops.notify_searchresults_new_rows = notify_searchresults_new_rows
224 c_notify_ui_ops.notify_userinfo = notify_userinfo
225 c_notify_ui_ops.notify_uri = notify_uri
226 c_notify_ui_ops.close_notify = close_notify
228 c_request_ui_ops.request_input = request_input
229 c_request_ui_ops.request_choice = request_choice
230 c_request_ui_ops.request_action = request_action
231 c_request_ui_ops.request_fields = request_fields
232 c_request_ui_ops.request_file = request_file
233 c_request_ui_ops.close_request = close_request
234 c_request_ui_ops.request_folder = request_folder
236 c_core_ui_ops.ui_prefs_init = <void (*)()> self.__core_ui_ops_ui_prefs_init
237 c_core_ui_ops.debug_ui_init = <void (*)()> self.__core_ui_ops_debug_init
238 c_core_ui_ops.ui_init = <void (*)()> self.__core_ui_ops_ui_init
239 c_core_ui_ops.quit = <void (*)()> self.__core_ui_ops_quit
240 c_core_ui_ops.get_ui_info = <glib.GHashTable* (*)()> self.__core_ui_ops_get_ui_info
242 c_eventloop_ui_ops.timeout_add = glib.g_timeout_add
243 c_eventloop_ui_ops.timeout_remove = glib.g_source_remove
244 c_eventloop_ui_ops.input_add = glib_input_add
245 c_eventloop_ui_ops.input_remove = glib.g_source_remove
246 c_eventloop_ui_ops.input_get_error = NULL
247 c_eventloop_ui_ops.timeout_add_seconds = NULL
249 core.purple_core_set_ui_ops(&c_core_ui_ops)
250 eventloop.purple_eventloop_set_ui_ops(&c_eventloop_ui_ops)
252 # initialize purple core
253 ret = core.purple_core_init(c_ui_name)
255 debug.purple_debug_fatal("main", "%s", "libpurple " \
256 "initialization failed.\n")
259 # check if there is another instance of libpurple running
260 if core.purple_core_ensure_single_instance() == False:
261 debug.purple_debug_fatal("main", "%s", "Another instance of " \
262 "libpurple is already running.\n")
263 core.purple_core_quit()
266 # create and load the buddy list
267 blist.purple_set_blist(blist.purple_blist_new())
268 blist.purple_blist_load()
271 pounce.purple_pounces_load()
275 def add_callback(self, type, name, callback):
276 '''Adds a callback with given name inside callback's type.
278 @param type Callback type (e.g. "account")
279 @param name Callback name (e.g. "notify-added")
280 @param callback Callback to be called
285 global connection_cbs
286 global conversation_cbs
290 { "account": account_cbs,
292 "connection": connection_cbs,
293 "conversation": conversation_cbs,
294 "notify": notify_cbs,
295 "request": request_cbs }[type][name] = callback
297 def signal_connect(self, name=None, cb=None):
298 '''Connects a signal handler to a callback for a particular object.
299 Take care not to register a handler function twice. Purple will
300 not correct any mistakes for you in this area.
302 @param name Name of the signal to connect.
303 @param cb Callback function.
307 cdef plugin.PurplePlugin *jabber
312 jabber = prpl.purple_find_prpl("prpl-jabber")
317 signal_cbs[name] = cb
319 if name == "signed-on":
320 signals.purple_signal_connect(
321 connection.purple_connections_get_handle(),
322 "signed-on", &handle,
323 <signals.PurpleCallback> signal_signed_on_cb, NULL)
324 elif name == "signed-off":
325 signals.purple_signal_connect(
326 connection.purple_connections_get_handle(),
327 "signed-off", &handle,
328 <signals.PurpleCallback> signal_signed_off_cb, NULL)
329 elif name == "connection-error":
330 signals.purple_signal_connect(
331 connection.purple_connections_get_handle(),
332 "connection-error", &handle,
333 <signals.PurpleCallback> signal_connection_error_cb, NULL)
334 elif name == "buddy-signed-on":
335 signals.purple_signal_connect(
336 blist.purple_blist_get_handle(),
337 "buddy-signed-on", &handle,
338 <signals.PurpleCallback> signal_buddy_signed_on_cb, NULL)
339 elif name == "buddy-signed-off":
340 signals.purple_signal_connect(
341 blist.purple_blist_get_handle(),
342 "buddy-signed-off", &handle,
343 <signals.PurpleCallback> signal_buddy_signed_off_cb, NULL)
344 elif name == "receiving-im-msg":
345 signals.purple_signal_connect(
346 conversation.purple_conversations_get_handle(),
347 "receiving-im-msg", &handle,
348 <signals.PurpleCallback> signal_receiving_im_msg_cb, NULL)
349 elif name == "jabber-receiving-xmlnode":
350 signals.purple_signal_connect(
351 jabber, "jabber-receiving-xmlnode", &handle,
352 <signals.PurpleCallback> jabber_receiving_xmlnode_cb, NULL)
354 def accounts_get_all(self):
355 '''Returns a list of all accounts.
357 @return A list of all accounts.
360 cdef glib.GList *iter
361 cdef account.PurpleAccount *acc
363 cdef char *protocol_id
365 iter = account.purple_accounts_get_all()
369 acc = <account.PurpleAccount *> iter.data
371 if <account.PurpleAccount *>acc:
372 username = <char *> account.purple_account_get_username(acc)
373 protocol_id = <char *> account.purple_account_get_protocol_id(acc)
375 if username != NULL and protocol_id != NULL:
376 account_list.append(Account(username, \
377 Protocol(protocol_id), self))
382 def accounts_get_all_active(self):
383 '''Returns a list of all enabled accounts.
385 @return A list of all enabled accounts.
388 cdef glib.GList *iter
389 cdef account.PurpleAccount *acc
391 cdef char *protocol_id
393 #FIXME: The list is owned by the caller, and must be g_list_free()d
394 # to avoid leaking the nodes.
396 iter = account.purple_accounts_get_all_active()
400 acc = <account.PurpleAccount *> iter.data
402 if <account.PurpleAccount *>acc:
403 username = <char *> account.purple_account_get_username(acc)
404 protocol_id = <char *> account.purple_account_get_protocol_id(acc)
406 if username != NULL and protocol_id != NULL:
407 account_list.append(Account(username, \
408 Protocol(protocol_id), self))
413 def iterate_main_loop(self):
414 glib.g_main_context_iteration(NULL, False)
417 def protocols_get_all(self):
418 '''Returns a list of all protocols.
420 @return A list of all protocols.
423 cdef glib.GList *iter
424 cdef plugin.PurplePlugin *pp
426 iter = plugin.purple_plugins_get_protocols()
429 pp = <plugin.PurplePlugin*> iter.data
430 if pp.info and pp.info.name:
431 protocol_list.append(Protocol(pp.info.id))
435 def call_action(self, i):
438 include "protocol.pyx"
439 #include "plugin.pyx"
441 include "account.pyx"
443 #include "connection.pyx"
444 include "conversation.pyx"