X-Git-Url: http://git.maemo.org/git/?p=python-purple;a=blobdiff_plain;f=purple.pyx;h=17411e78233f6ae7c2035846ba327b5f242f1219;hp=6a269cd1a2c8de4a5f69e33ce40180bda1844d75;hb=39c1c26cdc38fe7dc79122c45bba7731b08ed1cd;hpb=90f6e43b25dd3932fcc71a4f7afa5ecfcf2e3dc4 diff --git a/purple.pyx b/purple.pyx index 6a269cd..17411e7 100644 --- a/purple.pyx +++ b/purple.pyx @@ -23,10 +23,16 @@ cdef extern from "c_purple.h": glib.guint glib_input_add(glib.gint fd, eventloop.PurpleInputCondition condition, eventloop.PurpleInputFunction function, glib.gpointer data) import ecore +import signal -__DEFAULT_PATH__ = "/tmp" -__APP_NAME__ = "carman-purple-python" -__APP_VERSION__ = "0.1" +cdef glib.GHashTable *c_ui_info + +c_ui_info = NULL + +cdef char *c_ui_name +cdef char *c_ui_version +cdef char *c_ui_website +cdef char *c_ui_dev_website cdef account.PurpleAccountUiOps c_account_ui_ops cdef blist.PurpleBlistUiOps c_blist_ui_ops @@ -40,10 +46,6 @@ cdef notify.PurpleNotifyUiOps c_notify_ui_ops cdef request.PurpleRequestUiOps c_request_ui_ops #cdef roomlist.PurpleRoomlistUiOps c_rlist_ui_ops -cdef glib.GHashTable *c_ui_info - -c_ui_info = NULL - include "account_cbs.pxd" include "blist_cbs.pxd" include "connection_cbs.pxd" @@ -58,82 +60,113 @@ include "signal_cbs.pxd" include "util.pxd" cdef class Purple: - """ Purple class. + '''Purple class. + + @param ui_name ID of the UI using the purple. + This should be a unique ID, registered with the purple team. + @param ui_version UI version. + @param ui_website UI website. + @param ui_dev_website UI development website. + @param debug_enabled True to enable debug messages. + @param default_path Custom settings directory + ''' - @parm debug_enabled: Toggle debug messages. - @parm app_name: Set application name. - @parm default_path: Full path for libpurple user files. - """ - cdef object __accounts + def __init__(self, ui_name, ui_version, ui_website, ui_dev_website, \ + debug_enabled=None, default_path=None): - def __init__(self, debug_enabled=True, app_name=__APP_NAME__, default_path=__DEFAULT_PATH__): - self.__accounts = {} - if app_name is not __APP_NAME__: - __APP_NAME__ = app_name + global c_ui_name + global c_ui_version + global c_ui_website + global c_ui_dev_website - if default_path is not __DEFAULT_PATH__: - __DEFAULT_PATH__ = default_path + c_ui_name = ui_name + c_ui_version = ui_version + c_ui_website = ui_website + c_ui_dev_website = ui_dev_website - debug.c_purple_debug_set_enabled(debug_enabled) - util.c_purple_util_set_user_dir(default_path) - plugin.c_purple_plugins_add_search_path(default_path) + if debug_enabled: + debug.purple_debug_set_enabled(debug_enabled) + + if default_path: + util.purple_util_set_user_dir(default_path) # adds glib iteration inside ecore main loop ecore.timer_add(0.001, self.__glib_iteration_when_idle) + # libpurple's built-in DNS resolution forks processes to perform + # blocking lookups without blocking the main process. It does not + # handle SIGCHLD itself, so if the UI does not you quickly get an army + # of zombie subprocesses marching around. + signal.signal(signal.SIGCHLD, signal.SIG_IGN) + def destroy(self): - core.c_purple_core_quit() + core.purple_core_quit() + + def __get_ui_name(self): + '''Returns the UI name. + + @return UI name. + ''' + + global c_ui_name + return str(c_ui_name) + ui_name = property(__get_ui_name) cdef void __core_ui_ops_ui_prefs_init(self): - debug.c_purple_debug_info("core_ui_ops", "%s", "ui_prefs_init\n") - prefs.c_purple_prefs_load() + debug.purple_debug_info("core_ui_ops", "%s", "ui_prefs_init\n") + prefs.purple_prefs_load() - prefs.c_purple_prefs_add_none("/carman") + prefs.purple_prefs_add_none("/carman") cdef void __core_ui_ops_debug_init(self): - debug.c_purple_debug_info("core_ui_ops", "%s", "debug_ui_init\n") + debug.purple_debug_info("core_ui_ops", "%s", "debug_ui_init\n") pass cdef void __core_ui_ops_ui_init(self): - debug.c_purple_debug_info("core_ui_ops", "%s", "ui_init\n") + debug.purple_debug_info("core_ui_ops", "%s", "ui_init\n") account.purple_accounts_set_ui_ops(&c_account_ui_ops) - connection.c_purple_connections_set_ui_ops(&c_conn_ui_ops) - blist.c_purple_blist_set_ui_ops(&c_blist_ui_ops) - conversation.c_purple_conversations_set_ui_ops(&c_conv_ui_ops) - notify.c_purple_notify_set_ui_ops(&c_notify_ui_ops) - #privacy.c_purple_privacy_set_ui_ops(&c_privacy_ui_ops) - request.c_purple_request_set_ui_ops(&c_request_ui_ops) - #ft.c_purple_xfers_set_ui_ops(&c_ft_ui_ops) - #roomlist.c_purple_roomlist_set_ui_ops(&c_rlist_ui_ops) + connection.purple_connections_set_ui_ops(&c_conn_ui_ops) + blist.purple_blist_set_ui_ops(&c_blist_ui_ops) + conversation.purple_conversations_set_ui_ops(&c_conv_ui_ops) + notify.purple_notify_set_ui_ops(&c_notify_ui_ops) + #privacy.purple_privacy_set_ui_ops(&c_privacy_ui_ops) + request.purple_request_set_ui_ops(&c_request_ui_ops) + #ft.purple_xfers_set_ui_ops(&c_ft_ui_ops) + #roomlist.purple_roomlist_set_ui_ops(&c_rlist_ui_ops) cdef void __core_ui_ops_quit(self): - debug.c_purple_debug_info("core_ui_ops", "%s", "quit\n") - - global c_ui_info + debug.purple_debug_info("core_ui_ops", "%s", "quit\n") account.purple_accounts_set_ui_ops(NULL) - connection.c_purple_connections_set_ui_ops(NULL) - blist.c_purple_blist_set_ui_ops(NULL) - conversation.c_purple_conversations_set_ui_ops(NULL) - notify.c_purple_notify_set_ui_ops(NULL) - #privacy.c_purple_privacy_set_ui_ops(NULL) - request.c_purple_request_set_ui_ops(NULL) - #ft.c_purple_xfers_set_ui_ops(NULL) - #roomlist.c_purple_roomlist_set_ui_ops(NULL) - - if c_ui_info: - glib.g_hash_table_destroy(c_ui_info) + connection.purple_connections_set_ui_ops(NULL) + blist.purple_blist_set_ui_ops(NULL) + conversation.purple_conversations_set_ui_ops(NULL) + notify.purple_notify_set_ui_ops(NULL) + #privacy.purple_privacy_set_ui_ops(NULL) + request.purple_request_set_ui_ops(NULL) + #ft.purple_xfers_set_ui_ops(NULL) + #roomlist.purple_roomlist_set_ui_ops(NULL) + + if self.c_ui_info: + glib.g_hash_table_destroy( self.c_ui_info) cdef glib.GHashTable *__core_ui_ops_get_ui_info(self): global c_ui_info + global c_ui_name + global c_ui_version + global c_ui_website + global c_ui_dev_website if c_ui_info == NULL: - c_ui_info = glib.g_hash_table_new(glib.g_str_hash, glib.g_str_equal) + c_ui_info = glib.g_hash_table_new(glib.g_str_hash, \ + glib.g_str_equal) - glib.g_hash_table_insert(c_ui_info, "name", __APP_NAME__) - glib.g_hash_table_insert(c_ui_info, "version", __APP_VERSION__) + glib.g_hash_table_insert(c_ui_info, "name", c_ui_name) + glib.g_hash_table_insert(c_ui_info, "version", c_ui_version) + glib.g_hash_table_insert(c_ui_info, "website", c_ui_website) + glib.g_hash_table_insert(c_ui_info, "dev_website", c_ui_dev_website) return c_ui_info def __glib_iteration_when_idle(self): @@ -141,7 +174,12 @@ cdef class Purple: return True def purple_init(self): - """ Initializes libpurple """ + '''Initializes the purple. + + This will setup preferences for all the core subsystems. + ''' + + global c_ui_name c_account_ui_ops.notify_added = notify_added c_account_ui_ops.status_changed = status_changed @@ -216,40 +254,40 @@ cdef class Purple: c_eventloop_ui_ops.input_get_error = NULL c_eventloop_ui_ops.timeout_add_seconds = NULL - core.c_purple_core_set_ui_ops(&c_core_ui_ops) - eventloop.c_purple_eventloop_set_ui_ops(&c_eventloop_ui_ops) + core.purple_core_set_ui_ops(&c_core_ui_ops) + eventloop.purple_eventloop_set_ui_ops(&c_eventloop_ui_ops) # initialize purple core - ret = core.c_purple_core_init(__APP_NAME__) + ret = core.purple_core_init(c_ui_name) if ret is False: - debug.c_purple_debug_fatal("main", "%s", "libpurple " \ + debug.purple_debug_fatal("main", "%s", "libpurple " \ "initialization failed.\n") return False # check if there is another instance of libpurple running - if core.c_purple_core_ensure_single_instance() == False: - debug.c_purple_debug_fatal("main", "%s", "Another instance of " \ + if core.purple_core_ensure_single_instance() == False: + debug.purple_debug_fatal("main", "%s", "Another instance of " \ "libpurple is already running.\n") - core.c_purple_core_quit() + core.purple_core_quit() return False # create and load the buddy list - blist.c_purple_set_blist(blist.c_purple_blist_new()) - blist.c_purple_blist_load() + blist.purple_set_blist(blist.purple_blist_new()) + blist.purple_blist_load() # load pounces - pounce.c_purple_pounces_load() - - # initialize accounts - self.load_accounts() + pounce.purple_pounces_load() return ret def add_callback(self, type, name, callback): - """ - Adds a callback with given name inside callback's type. - Example: add_callback("account", "notify-added", notify_added_cb) - """ + '''Adds a callback with given name inside callback's type. + + @param type Callback type (e.g. "account") + @param name Callback name (e.g. "notify-added") + @param callback Callback to be called + ''' + global account_cbs global blist_cbs global connection_cbs @@ -265,13 +303,21 @@ cdef class Purple: "request": request_cbs }[type][name] = callback def signal_connect(self, name=None, cb=None): + '''Connects a signal handler to a signal for a particular object. + Take care not to register a handler function twice. Purple will + not correct any mistakes for you in this area. + + @param name Name of the signal to connect. + @param cb Callback function. + ''' + cdef int handle cdef plugin.PurplePlugin *jabber if name is None: return - jabber = prpl.c_purple_find_prpl("prpl-jabber") + jabber = prpl.purple_find_prpl("prpl-jabber") if jabber == NULL: return @@ -279,86 +325,83 @@ cdef class Purple: signal_cbs[name] = cb if name == "signed-on": - signals.c_purple_signal_connect( - connection.c_purple_connections_get_handle(), + signals.purple_signal_connect( + connection.purple_connections_get_handle(), "signed-on", &handle, signal_signed_on_cb, NULL) elif name == "signed-off": - signals.c_purple_signal_connect( - connection.c_purple_connections_get_handle(), + signals.purple_signal_connect( + connection.purple_connections_get_handle(), "signed-off", &handle, signal_signed_off_cb, NULL) elif name == "connection-error": - signals.c_purple_signal_connect( - connection.c_purple_connections_get_handle(), + signals.purple_signal_connect( + connection.purple_connections_get_handle(), "connection-error", &handle, signal_connection_error_cb, NULL) elif name == "buddy-signed-on": - signals.c_purple_signal_connect( - blist.c_purple_blist_get_handle(), + signals.purple_signal_connect( + blist.purple_blist_get_handle(), "buddy-signed-on", &handle, signal_buddy_signed_on_cb, NULL) elif name == "buddy-signed-off": - signals.c_purple_signal_connect( - blist.c_purple_blist_get_handle(), + signals.purple_signal_connect( + blist.purple_blist_get_handle(), "buddy-signed-off", &handle, signal_buddy_signed_off_cb, NULL) elif name == "receiving-im-msg": - signals.c_purple_signal_connect( - conversation.c_purple_conversations_get_handle(), + signals.purple_signal_connect( + conversation.purple_conversations_get_handle(), "receiving-im-msg", &handle, signal_receiving_im_msg_cb, NULL) elif name == "jabber-receiving-xmlnode": - signals.c_purple_signal_connect( + signals.purple_signal_connect( jabber, "jabber-receiving-xmlnode", &handle, jabber_receiving_xmlnode_cb, NULL) - def __get_accounts(self): - return self.__accounts - accounts = property(__get_accounts) + def accounts_get_all(self): + '''Returns a list of all accounts. - def new_account(self, username, protocol_id): - acc = Account(username, protocol_id) - return acc + @return A list of all accounts. + ''' - def load_accounts(self): cdef glib.GList *iter cdef account.PurpleAccount *acc + cdef char *username + cdef char *protocol_id + iter = account.purple_accounts_get_all() + account_list = [] + while iter: acc = iter.data + if acc: username = account.purple_account_get_username(acc) protocol_id = account.purple_account_get_protocol_id(acc) - self.account_add(username.split("/")[0], protocol_id, \ - "172.18.216.211", 8080) + + if username != NULL and protocol_id != NULL: + account_list.append(Account(username, \ + Protocol(protocol_id), self)) iter = iter.next - def account_add(self, username, protocol_id, host, port): - if not self.account_verify(username): - acc = purple.Account(username, protocol_id) - self.__accounts[username] = acc - if not account.purple_accounts_find(username, protocol_id): - acc.proxy.set_type(purple.ProxyInfoType().HTTP) - acc.proxy.set_host(host) - acc.proxy.set_port(port) - acc.save_into_xml() - - def account_verify(self, acc_username): - if self.__accounts: - for username in self.__accounts.keys(): - if acc_username == username: - return self.__accounts[username] - else: - return None + return account_list + + def accounts_get_all_active(self): + '''Returns a list of all enabled accounts. + + @return A list of all enabled accounts. + ''' - def accounts_get_all(self): cdef glib.GList *iter cdef account.PurpleAccount *acc cdef char *username cdef char *protocol_id - iter = account.purple_accounts_get_all() + #FIXME: The list is owned by the caller, and must be g_list_free()d + # to avoid leaking the nodes. + + iter = account.purple_accounts_get_all_active() account_list = [] while iter: @@ -369,16 +412,38 @@ cdef class Purple: protocol_id = account.purple_account_get_protocol_id(acc) if username != NULL and protocol_id != NULL: - account_list.append(Account(username, protocol_id)) + account_list.append(Account(username, \ + Protocol(protocol_id), self)) iter = iter.next return account_list -include "plugin.pyx" + def protocols_get_all(self): + '''Returns a list of all protocols. + + @return A list of all protocols. + ''' + + cdef glib.GList *iter + cdef plugin.PurplePlugin *pp + + iter = plugin.purple_plugins_get_protocols() + protocol_list = [] + while iter: + pp = iter.data + if pp.info and pp.info.name: + protocol_list.append(Protocol(pp.info.id)) + iter = iter.next + return protocol_list + + def call_action(self, i): + __call_action(i) + +include "protocol.pyx" +#include "plugin.pyx" include "proxy.pyx" #include "protocol.pyx" include "account.pyx" include "buddy.pyx" #include "connection.pyx" include "conversation.pyx" -