X-Git-Url: http://git.maemo.org/git/?p=python-purple;a=blobdiff_plain;f=account.pyx;h=5935ba914268f4d140c41d984086ae840060262b;hp=4b3af4bf0e07831b11b96539cd3baa5e4e91ff59;hb=7752e0f4a14a32ede02b8b86c83d9510338a59ed;hpb=7b3a84e1d328964d372cd4d3f891ab0d4619adfd diff --git a/account.pyx b/account.pyx index 4b3af4b..5935ba9 100644 --- a/account.pyx +++ b/account.pyx @@ -19,155 +19,146 @@ cimport purple -cdef extern from *: - ctypedef char const_char "const char" - cdef class Account: - """ Account class """ - cdef account.PurpleAccount *c_account - cdef plugin.PurplePlugin *c_plugin - cdef prpl.PurplePluginProtocolInfo *c_prpl_info - cdef plugin.PurplePluginInfo *c_plugin_info - cdef savedstatuses.PurpleSavedStatus *__sstatus - cdef ProxyInfo __proxy - - def __init__(self, char *username, char *protocol_id): - cdef proxy.PurpleProxyInfo *c_proxyinfo - cdef account.PurpleAccount *acc = NULL - - acc = account.c_purple_accounts_find(username, protocol_id) - if acc: - self.c_account = acc - c_proxyinfo = account.c_purple_account_get_proxy_info(self.c_account) + """ + Account class + @param username + @param protocol Protocol class instance + @param core Purple class instance + """ + + cdef object __username + cdef object __protocol + cdef object __core + cdef object __exists + + def __init__(self, username, protocol, core): + self.__username = username + self.__protocol = protocol + self.__core = core + + if protocol.exists and self._get_structure() != NULL: + self.__exists = True else: - self.c_account = account.c_purple_account_new(username, protocol_id) - c_proxyinfo = account.c_purple_account_get_proxy_info(self.c_account) - if c_proxyinfo == NULL: - c_proxyinfo = proxy.c_purple_proxy_info_new() - proxy.c_purple_proxy_info_set_type(c_proxyinfo, proxy.PURPLE_PROXY_NONE) - account.c_purple_account_set_proxy_info(self.c_account, c_proxyinfo) - self.__proxy = ProxyInfo() - self.__proxy.c_proxyinfo = c_proxyinfo - acc = NULL - - self.c_plugin = plugin.c_purple_plugins_find_with_id(protocol_id) - self.c_prpl_info = plugin.c_PURPLE_PLUGIN_PROTOCOL_INFO(self.c_plugin) + self.__exists = False - def __get_username(self): - if self.c_account: - return account.c_purple_account_get_username(self.c_account) - else: - return None - def __set_username(self, username): - if self.c_account: - account.c_purple_account_set_username(self.c_account, username) - username = property(__get_password, __set_username) + cdef account.PurpleAccount *_get_structure(self): + return account.purple_accounts_find(self.__username, \ + self.__protocol.id) - def __get_password(self): - if self.c_account: - return account.c_purple_account_get_password(self.c_account) + def __is_connected(self): + if self.__exists: + return account.purple_account_is_connected(self._get_structure()) else: return None - def __set_password(self, password): - if self.c_account: - account.c_purple_account_set_password(self.c_account, password) - password = property(__get_password, __set_password) + is_connected = property(__is_connected) - def __get_alias(self): - if self.c_account: - return account.c_purple_account_get_alias(self.c_account) + def __is_connecting(self): + if self.__exists: + return account.purple_account_is_connecting(self._get_structure()) else: return None - def __set_alias(self, alias): - if self.c_account: - account.c_purple_account_set_alias(self.c_account, alias) - alias = property(__get_alias, __set_alias) + is_connecting = property(__is_connecting) - def __get_user_info(self): - if self.c_account: - return account.c_purple_account_get_user_info(self.c_account) - else: - return None - def __set_user_info(self, user_info): - if self.c_account: - account.c_purple_account_set_user_info(self.c_account, user_info) - user_info = property(__get_user_info, __set_user_info) - - def __get_protocol_id(self): - if self.c_account: - return account.c_purple_account_get_protocol_id(self.c_account) + def __is_disconnected(self): + if self.__exists: + return account.purple_account_is_disconnected( \ + self._get_structure()) else: return None - def __set_protocol_id(self, protocol_id): - if self.c_account: - account.c_purple_account_set_protocol_id(self.c_account, protocol_id) - protocol_id = property(__get_protocol_id, __set_protocol_id) + is_disconnected = property(__is_disconnected) - def __get_remember_password(self): - if self.c_account: - return account.c_purple_account_get_remember_password(self.c_account) + def __get_core(self): + return self.__core + core = property(__get_core) + + def __get_exists(self): + return self.__exists + exists = property(__get_exists) + + def __get_username(self): + cdef char *username = NULL + if self.__exists: + username = account.purple_account_get_username( \ + self._get_structure()) + if username: + return username + else: + return None else: - return None - def __set_remember_password(self, value): - if self.c_account: - account.c_purple_account_set_remember_password(self.c_account, value) - remember_password = property(__get_remember_password, __set_remember_password) + return self.__username + username = property(__get_username) + + def __get_protocol(self): + return self.__protocol + protocol = property(__get_protocol) def _get_protocol_options(self): + """ + @return Dictionary {'setting': value, ...} + """ cdef glib.GList *iter + cdef account.PurpleAccount *c_account + cdef plugin.PurplePlugin *c_plugin + cdef prpl.PurplePluginProtocolInfo *prpl_info cdef accountopt.PurpleAccountOption *option cdef prefs.PurplePrefType type - cdef const_char *label_name - cdef const_char *str_value - cdef const_char *setting + cdef char *label_name + cdef char *str_value + cdef char *setting cdef int int_value cdef glib.gboolean bool_value - if self.c_account == NULL: + c_account = self._get_structure() + + if c_account == NULL: return None po = {} - iter = self.c_prpl_info.protocol_options + c_plugin = plugin.purple_plugins_find_with_id(self.__protocol.id) + prpl_info = plugin.PURPLE_PLUGIN_PROTOCOL_INFO(c_plugin) + iter = prpl_info.protocol_options while iter: option = iter.data - type = accountopt.c_purple_account_option_get_type(option) - label_name = accountopt.c_purple_account_option_get_text(option) - setting = accountopt.c_purple_account_option_get_setting(option) + type = accountopt.purple_account_option_get_type(option) + label_name = accountopt.purple_account_option_get_text(option) + setting = accountopt.purple_account_option_get_setting(option) sett = str( setting) if type == prefs.PURPLE_PREF_STRING: - str_value = accountopt.c_purple_account_option_get_default_string(option) + str_value = accountopt.purple_account_option_get_default_string(option) - # Google Talk default domain hackery! - if str_value == NULL and str( label_name) == "Connect server": - str_value = "talk.google.com" - str_value = account.c_purple_account_get_string(self.c_account, setting, str_value) + # Hack to set string "" as default value to Account options when + # the default value of the protocol is NULL + if str_value == NULL: + str_value = "" + str_value = account.purple_account_get_string(c_account, setting, str_value) val = str( str_value) elif type == prefs.PURPLE_PREF_INT: - int_value = accountopt.c_purple_account_option_get_default_int(option) - int_value = account.c_purple_account_get_int(self.c_account, setting, int_value) + int_value = accountopt.purple_account_option_get_default_int(option) + int_value = account.purple_account_get_int(c_account, setting, int_value) val = int(int_value) elif type == prefs.PURPLE_PREF_BOOLEAN: - bool_value = accountopt.c_purple_account_option_get_default_bool(option) - bool_value = account.c_purple_account_get_bool(self.c_account, setting, bool_value) + bool_value = accountopt.purple_account_option_get_default_bool(option) + bool_value = account.purple_account_get_bool(c_account, setting, bool_value) val = bool(bool_value) elif type == prefs.PURPLE_PREF_STRING_LIST: - str_value = accountopt.c_purple_account_option_get_default_list_value(option) - str_value = account.c_purple_account_get_string(self.c_account, setting, str_value) + str_value = accountopt.purple_account_option_get_default_list_value(option) + str_value = account.purple_account_get_string(c_account, setting, str_value) val = str( str_value) @@ -176,182 +167,505 @@ cdef class Account: po[sett] = val return po + protocol_options = property(_get_protocol_options) + + def __get_password(self): + cdef char *password = NULL + if self.__exists: + password = account.purple_account_get_password( \ + self._get_structure()) + if password: + return password + else: + return None + else: + return None + password = property(__get_password) + + def __get_alias(self): + cdef char *alias = NULL + if self.__exists: + alias = account.purple_account_get_alias(self._get_structure()) + if alias: + return alias + else: + return None + else: + return None + alias = property(__get_alias) - def _set_protocol_options(self, po): + def __get_user_info(self): + cdef char *user_info = NULL + if self.__exists: + user_info = account.purple_account_get_user_info(self._get_structure()) + if user_info: + return user_info + else: + return None + else: + return None + user_info = property(__get_user_info) + + def __get_remember_password(self): + if self.__exists: + return account.purple_account_get_remember_password( \ + self._get_structure()) + else: + return None + remember_password = property(__get_remember_password) + + def __get_enabled(self): + if self.__exists: + return account.purple_account_get_enabled(self._get_structure(), \ + self.__core.ui_name) + else: + return None + enabled = property(__get_enabled) + + def __get_status_types(self): + cdef glib.GList *iter = NULL + cdef status.PurpleStatusType *c_statustype = NULL + cdef char *id = NULL + cdef char *name = NULL + + status_types = [] + if self.__exists: + iter = account.purple_account_get_status_types(self._get_structure()) + while iter: + c_statustype = iter.data + id = status.purple_status_type_get_id(c_statustype) + name = status.purple_status_type_get_name(c_statustype) + status_types.append((id, name)) + iter = iter.next + + return status_types + + status_types = property(__get_status_types) + + def __get_active_status(self): + cdef status.PurpleStatus* c_status = NULL + cdef char *type = NULL + cdef char *name = NULL + cdef char *msg = NULL + if self.__exists: + active = {} + c_status = account.purple_account_get_active_status(self._get_structure()) + type = status.purple_status_get_id(c_status) + name = status.purple_status_get_name(c_status) + msg = status.purple_status_get_attr_string(c_status, + "message") + + active['type'] = type + active['name'] = name + if msg: + active['message'] = msg + + return active + else: + return None + active_status = property(__get_active_status) + + def set_username(self, username): + """ + Sets the account's username. + + @param username The username + @return True if successful, False if account doesn't exists + """ + if self.__exists: + account.purple_account_set_username(self._get_structure(), \ + username) + return True + else: + return False + + def set_protocol(self, protocol): + """ + Sets the account's protocol. + + @param protocol A Protocol class instance + @return True if successful, False if account doesn't exists + """ + if protocol.exists and self.__exists: + account.purple_account_set_protocol_id(self._get_structure(), \ + protocol.id) + self.__protocol = protocol + return True + else: + return False + + def set_protocol_options(self, po): + """ + @param po Dictionary {'setting': value, ...} options to be updated + @return True to success or False to failure + """ cdef glib.GList *iter + cdef account.PurpleAccount *c_account + cdef plugin.PurplePlugin *c_plugin + cdef prpl.PurplePluginProtocolInfo *prpl_info cdef accountopt.PurpleAccountOption *option cdef prefs.PurplePrefType type - cdef const_char *str_value - cdef const_char *setting + cdef char *str_value + cdef char *setting cdef int int_value cdef glib.gboolean bool_value - if self.c_account == NULL: - return + c_account = self._get_structure() - po = {} + if c_account == NULL: + return False - iter = self.c_prpl_info.protocol_options + c_plugin = plugin.purple_plugins_find_with_id(self.__protocol.id) + prpl_info = plugin.PURPLE_PLUGIN_PROTOCOL_INFO(c_plugin) + iter = prpl_info.protocol_options while iter: option = iter.data - type = accountopt.c_purple_account_option_get_type(option) - setting = accountopt.c_purple_account_option_get_setting(option) + type = accountopt.purple_account_option_get_type(option) + setting = accountopt.purple_account_option_get_setting(option) sett = str( setting) + if sett not in po: + iter = iter.next + continue + if type == prefs.PURPLE_PREF_STRING: str_value = po[sett] - account.c_purple_account_set_string(self.c_account, setting, str_value) + account.purple_account_set_string(c_account, setting, str_value) elif type == prefs.PURPLE_PREF_INT: int_value = int(po[sett]) - account.c_purple_account_set_int(self.c_account, setting, int_value) + account.purple_account_set_int(c_account, setting, int_value) elif type == prefs.PURPLE_PREF_BOOLEAN: bool_value = bool(po[sett]) - account.c_purple_account_set_bool(self.c_account, setting, bool_value) + account.purple_account_set_bool(c_account, setting, bool_value) elif type == prefs.PURPLE_PREF_STRING_LIST: str_value = po[sett] - account.c_purple_account_set_string(self.c_account, setting, str_value) + account.purple_account_set_string(c_account, setting, str_value) iter = iter.next - protocol_options = property(_get_protocol_options, _set_protocol_options) + return True - def _get_protocol_labels(self): - cdef glib.GList *iter - cdef accountopt.PurpleAccountOption *option - cdef const_char *label_name - cdef const_char *setting + def set_password(self, password): + """ + Sets the account's password. - if self.c_account == NULL: - return None + @param password The password + @return True if successful, False if account doesn't exists + """ + if self.__exists: + account.purple_account_set_password(self._get_structure(), \ + password) + return True + else: + return False + + def set_alias(self, alias): + """ + Sets the account's alias + + @param alias The alias + @return True if successful, False if account doesn't exists + """ + if self.__exists: + account.purple_account_set_alias(self._get_structure(), \ + alias) + return True + else: + return False + + def set_user_info(self, user_info): + """ + Sets the account's user information + + @param user_info The user information + @return True if successful, False if account doesn't exists + """ + if self.__exists: + account.purple_account_set_user_info(self._get_structure(), \ + user_info) + return True + else: + return False + + def set_remember_password(self, remember_password): + """ + Sets whether or not this account should save its password. + + @param remember_password True if should remember the password, + or False otherwise + @return True if successful, False if account doesn't exists + """ + if self.__exists: + account.purple_account_set_remember_password( \ + self._get_structure(), remember_password) + return True + else: + return False + + def set_enabled(self, value): + """ + Sets wheter or not this account is enabled. + + @param value True if it is enabled, or False otherwise + @return True if successful, False if account doesn't exists + """ + if self.__exists: + account.purple_account_set_enabled(self._get_structure(), \ + self.__core.ui_name, bool(value)) + return True + else: + return False - po = {} + def new(self): + """ + Creates a new account. - iter = self.c_prpl_info.protocol_options + @return True if successful, False if account already exists + """ + if self.__exists: + return False + else: + account.purple_accounts_add(account.purple_account_new( \ + self.__username, self.__protocol.id)) + + self.__exists = True + return True + + def remove(self): + """ + Removes an existing account. + + @return True if successful, False if account doesn't exists + """ + if self.__exists: + account.purple_accounts_delete(self._get_structure()) + self__exists = False + return True + else: + return False - while iter: + def connect(self): + """ + Connects to an account. - option = iter.data - label_name = accountopt.c_purple_account_option_get_text(option) - setting = accountopt.c_purple_account_option_get_setting(option) + @return True if successful, False if account doesn't exists + """ + if self.__exists: + account.purple_account_connect(self._get_structure()) + return True + else: + return False - sett = str( setting) - label = str( label_name) + def disconnect(self): + """ + Disconnects from an account. - po[sett] = label + @return True if successful, False if account doesn't exists + """ + if self.__exists: + account.purple_account_disconnect(self._get_structure()) + return True + else: + return False + + def add_buddy(self, name, alias=None, group=None): + """ + Adds a buddy to account's buddy list. + + @param name Buddy name + @param alias Buddy alias (optional) + @return True if successfull, False otherwise + """ + cdef blist.PurpleBuddy *c_buddy = NULL + cdef blist.PurpleGroup *c_group = NULL + cdef char *c_alias = NULL - return po + if alias: + c_alias = alias + else: + c_alias = NULL - protocol_labels = property(_get_protocol_labels) + if self.__exists and \ + account.purple_account_is_connected(self._get_structure()): + if blist.purple_find_buddy(self._get_structure(), name): + return False - def get_protocol_name(self): - if self.c_account: - return account.c_purple_account_get_protocol_name(self.c_account) - else: - return None + if group: + c_group = blist.purple_find_group(group) + if c_group == NULL: + c_group = blist.purple_group_new(group) + + c_buddy = blist.purple_buddy_new(self._get_structure(), \ + name, c_alias) + if c_buddy == NULL: + return False + + blist.purple_blist_add_buddy(c_buddy, NULL, c_group, NULL) + account.purple_account_add_buddy(self._get_structure(), c_buddy) + if c_alias: + blist.purple_blist_alias_buddy(c_buddy, c_alias) + server.serv_alias_buddy(c_buddy) + + return True - def get_enabled(self, ui): - if self.c_account: - return account.c_purple_account_get_enabled(self.c_account, ui) else: return None - def set_enabled(self, ui, value): - if self.c_account: - account.c_purple_account_set_enabled(self.c_account, ui, value) + def remove_buddy(self, name): + """ + Removes a buddy from account's buddy list. - def set_status(self): - self.__sstatus = savedstatuses.c_purple_savedstatus_new(NULL, status.PURPLE_STATUS_AVAILABLE) - savedstatuses.c_purple_savedstatus_activate(self.__sstatus) + @param name Buddy name + @return True if successful, False otherwise + """ + cdef blist.PurpleBuddy *c_buddy = NULL + cdef blist.PurpleGroup *c_group = NULL - def __get_proxy(self): - return self.__proxy - proxy = property(__get_proxy) + if self.__exists and \ + account.purple_account_is_connected(self._get_structure()): + c_buddy = blist.purple_find_buddy(self._get_structure(), name) + if c_buddy == NULL: + return False + + c_group = blist.purple_buddy_get_group(c_buddy) + + account.purple_account_remove_buddy(self._get_structure(), \ + c_buddy, c_group) + blist.purple_blist_remove_buddy(c_buddy) + return True + else: + return None def get_buddies_online(self): - cdef glib.GSList *iter - cdef blist.PurpleBuddy *buddy - cdef char *c_name = NULL + cdef glib.GSList *iter = NULL + cdef blist.PurpleBuddy *c_buddy = NULL cdef char *c_alias = NULL - buddies = [] - iter = blist.c_purple_find_buddies(self.c_account, NULL) - while iter: - c_name = NULL - c_alias = NULL - buddy = iter.data - if buddy and \ - account.c_purple_account_is_connected(blist.c_purple_buddy_get_account(buddy)) and \ - status.c_purple_presence_is_online(blist.c_purple_buddy_get_presence(buddy)): - c_name = blist.c_purple_buddy_get_name(buddy) - if c_name == NULL: - name = None - else: - name = c_name - c_alias = blist.c_purple_buddy_get_alias_only(buddy) - if c_alias == NULL: - alias = None - else: - alias = c_alias - buddies.append((name, alias)) - iter = iter.next - return buddies - def get_protocol_options(self): - ''' FIXME: It is just a hack, to set the XMPP's options. ''' - cdef glib.GList *iter - cdef accountopt.PurpleAccountOption *option - cdef prefs.PurplePrefType type - cdef const_char *label_name - cdef const_char *str_value - cdef const_char *setting - cdef int int_value - cdef glib.gboolean bool_value - iter = self.c_prpl_info.protocol_options - while iter: - option = iter.data - type = accountopt.c_purple_account_option_get_type(option) - label_name = accountopt.c_purple_account_option_get_text(option) - setting = accountopt.c_purple_account_option_get_setting(option) - if type == prefs.PURPLE_PREF_STRING: - str_value = accountopt.c_purple_account_option_get_default_string(option) + buddies_list = [] + if self.__exists and \ + account.purple_account_is_connected(self._get_structure()): + iter = blist.purple_find_buddies(self._get_structure(), NULL) - # Google Talk default domain hackery! - if str_value == NULL and str( label_name) == "Connect server": - str_value = "talk.google.com" + while iter: + c_alias = NULL + c_buddy = iter.data + if c_buddy and \ + status.purple_presence_is_online( \ + blist.purple_buddy_get_presence(c_buddy)): + name = blist.purple_buddy_get_name(c_buddy) - if self.c_account != NULL: - str_value = account.c_purple_account_get_string(self.c_account, setting, str_value) - account.c_purple_account_set_string(self.c_account, setting, str_value) + new_buddy = Buddy(name, self) - elif type == prefs.PURPLE_PREF_INT: - int_value = accountopt.c_purple_account_option_get_default_int(option) - if self.c_account != NULL: - int_value = account.c_purple_account_get_int(self.c_account, setting, int_value) - if str( setting) == "port": - account.c_purple_account_set_int(self.c_account, setting, 443) + c_alias = blist.purple_buddy_get_alias_only(c_buddy) + if c_alias: + new_buddy.set_alias(c_alias) - elif type == prefs.PURPLE_PREF_BOOLEAN: - bool_value = accountopt.c_purple_account_option_get_default_bool(option) - if self.c_account != NULL: - bool_value = account.c_purple_account_get_bool(self.c_account, setting, bool_value) - if str( setting) == "old_ssl": - account.c_purple_account_set_bool(self.c_account, setting, True) + buddies_list.append(new_buddy) + iter = iter.next - elif type == prefs.PURPLE_PREF_STRING_LIST: - str_value = accountopt.c_purple_account_option_get_default_list_value(option) - if self.c_account != NULL: - str_value = account.c_purple_account_get_string(self.c_account, setting, str_value) + return buddies_list - iter = iter.next + def get_buddies(self): + """ + @return Account's buddies list + """ + cdef glib.GSList *iter = NULL + cdef blist.PurpleBuddy *c_buddy = NULL + cdef char *c_alias = NULL + + buddies_list = [] + if self.__exists: + iter = blist.purple_find_buddies(self._get_structure(), NULL) + + while iter: + c_alias = NULL + c_buddy = iter.data + + name = blist.purple_buddy_get_name(c_buddy) + new_buddy = Buddy(name, self) + + c_alias = blist.purple_buddy_get_alias_only(c_buddy) + if c_alias: + new_buddy.set_alias(c_alias) - def save_into_xml(self): - account.c_purple_accounts_add(self.c_account) + buddies_list.append(new_buddy) + iter = iter.next + + return buddies_list + + def request_add_buddy(self, buddy_username, buddy_alias): + if buddy_alias: + blist.purple_blist_request_add_buddy(self._get_structure(), \ + buddy_username, NULL, buddy_alias) + else: + blist.purple_blist_request_add_buddy(self._get_structure(), \ + buddy_username, NULL, NULL) + + def set_active_status(self, type, msg=None): + cdef status.PurpleStatusType *c_statustype = NULL + cdef savedstatuses.PurpleSavedStatus *c_savedstatus = NULL + + if self.__exists: + if msg: + account.purple_account_set_status(self._get_structure(), + type, True, "message", msg, NULL) + else: + account.purple_account_set_status(self._get_structure(), + type, True, NULL) + + # FIXME: We can create only a savedstatus for each statustype + c_savedstatus = savedstatuses.purple_savedstatus_find(type) + if c_savedstatus == NULL: + c_statustype = account.purple_account_get_status_type( \ + self._get_structure(), type) + c_savedstatus = savedstatuses.purple_savedstatus_new( \ + NULL, status.purple_status_type_get_primitive( \ + c_statustype)) + savedstatuses.purple_savedstatus_set_title(c_savedstatus, + type) + + savedstatuses.purple_savedstatus_set_message(c_savedstatus, msg) + prefs.purple_prefs_set_int("/purple/savedstatus/idleaway", + savedstatuses.purple_savedstatus_get_creation_time(c_savedstatus)) + + return True + else: + return False + + def set_status_message(self, type, msg): + cdef status.PurpleStatus* c_status = NULL + cdef status.PurpleStatusType *c_statustype = NULL + cdef savedstatuses.PurpleSavedStatus *c_savedstatus = NULL + + if self.__exists and msg: + c_status = account.purple_account_get_status(self._get_structure(), + type) + if c_status == NULL: + return False + status.purple_status_set_attr_string(c_status, "message", msg) + + # FIXME: We can create only a savedstatus for each statustype + c_savedstatus = savedstatuses.purple_savedstatus_find(type) + if c_savedstatus == NULL: + c_statustype = account.purple_account_get_status_type( \ + self._get_structure(), type) + c_savedstatus = savedstatuses.purple_savedstatus_new( \ + NULL, status.purple_status_type_get_primitive( \ + c_statustype)) + savedstatuses.purple_savedstatus_set_title(c_savedstatus, + type) + + savedstatuses.purple_savedstatus_set_message(c_savedstatus, msg) + return True + else: + return False