Fixed protocol append typo on purple.pyx.
[python-purple] / account.pyx
index e569c52..8973bfe 100644 (file)
 
 cimport purple
 
 
 cimport purple
 
-cdef extern from *:
-    ctypedef char const_char "const char"
-
 cdef class Account:
 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
-        self.c_account = account.c_purple_account_new(username, protocol_id)
-        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)
-
-        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
+    """
+    Account class
+    @param username
+    @param protocol Protocol class instance
+    @param core Purple class instance
+    """
 
 
-    def __get_username(self):
-        if self.c_account:
-            return account.c_purple_account_get_username(self.c_account)
+    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.__exists = False
+
+    cdef account.PurpleAccount *_get_structure(self):
+        return account.purple_accounts_find(self.__username, \
+                self.__protocol.id)
+
+    def __is_connected(self):
+        if self.__exists:
+            return account.purple_account_is_connected(self._get_structure())
         else:
             return None
         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)
+    is_connected = property(__is_connected)
 
 
-    def __get_password(self):
-        if self.c_account:
-            return account.c_purple_account_get_password(self.c_account)
+    def __is_connecting(self):
+        if self.__exists:
+            return account.purple_account_is_connecting(self._get_structure())
         else:
             return None
         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_connecting = property(__is_connecting)
 
 
-    def __get_alias(self):
-        if self.c_account:
-            return account.c_purple_account_get_alias(self.c_account)
+    def __is_disconnected(self):
+        if self.__exists:
+            return account.purple_account_is_disconnected( \
+                    self._get_structure())
         else:
             return None
         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_disconnected = property(__is_disconnected)
 
 
-    def __get_user_info(self):
-        if self.c_account:
-            return account.c_purple_account_get_user_info(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 = <char *> account.purple_account_get_username( \
+                    self._get_structure())
+            if username:
+                return username
+            else:
+                return None
         else:
         else:
+            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 char *label_name
+        cdef char *str_value
+        cdef char *setting
+        cdef int int_value
+        cdef glib.gboolean bool_value
+
+        c_account = self._get_structure()
+
+        if c_account == NULL:
             return None
             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)
+        po = {}
+
+        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 = <accountopt.PurpleAccountOption *> iter.data
+            type = accountopt.purple_account_option_get_type(option)
+            label_name = <char *> accountopt.purple_account_option_get_text(option)
+            setting = <char *> accountopt.purple_account_option_get_setting(option)
+
+            sett = str(<char *> setting)
+
+            if type == prefs.PURPLE_PREF_STRING:
+
+                str_value = <char *> accountopt.purple_account_option_get_default_string(option)
+
+                # Google Talk default domain hackery!
+                if str_value == NULL and str(<char *> label_name) == "Connect server":
+                    str_value = "talk.google.com"
+                str_value = <char *> account.purple_account_get_string(c_account, setting, str_value)
+
+                val = str(<char *> str_value)
+
+            elif type == prefs.PURPLE_PREF_INT:
+
+                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.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 = <char *> accountopt.purple_account_option_get_default_list_value(option)
+                str_value = <char *> account.purple_account_get_string(c_account, setting, str_value)
+
+                val = str(<char *> str_value)
+
+            iter = iter.next
+
+            po[sett] = val
+
+        return po
+    protocol_options = property(_get_protocol_options)
+
+    def __get_password(self):
+        cdef char *password = NULL
+        if self.__exists:
+            password = <char *> account.purple_account_get_password( \
+                    self._get_structure())
+            if password:
+                return password
+            else:
+                return None
         else:
             return None
         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)
+    password = property(__get_password)
 
 
-    def __get_remember_password(self):
-        if self.c_account:
-            return account.c_purple_account_get_remember_password(self.c_account)
+    def __get_alias(self):
+        cdef char *alias = NULL
+        if self.__exists:
+            alias = <char *> account.purple_account_get_alias(self._get_structure())
+            if alias:
+                return alias
+            else:
+                return None
         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)
+    alias = property(__get_alias)
 
 
-    def get_protocol_name(self):
-        if self.c_account:
-            return account.c_purple_account_get_protocol_name(self.c_account)
+    def __get_user_info(self):
+        cdef char *user_info = NULL
+        if self.__exists:
+            user_info = <char *> account.purple_account_get_user_info(self._get_structure())
+            if user_info:
+                return user_info
+            else:
+                return None
         else:
             return None
         else:
             return None
+    user_info = property(__get_user_info)
 
 
-    def get_enabled(self, ui):
-        if self.c_account:
-            return account.c_purple_account_get_enabled(self.c_account, ui)
+    def __get_remember_password(self):
+        if self.__exists:
+            return account.purple_account_get_remember_password( \
+                    self._get_structure())
         else:
             return None
         else:
             return None
+    remember_password = property(__get_remember_password)
 
 
-    def set_enabled(self, ui, value):
-        if self.c_account:
-            account.c_purple_account_set_enabled(self.c_account, ui, value)
+    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 set_status(self):
-        self.__sstatus = savedstatuses.c_purple_savedstatus_new(NULL, status.PURPLE_STATUS_AVAILABLE)
-        savedstatuses.c_purple_savedstatus_activate(self.__sstatus)
+    def set_username(self, username):
+        """
+        Sets the account's username.
 
 
-    def __get_proxy(self):
-        return self.__proxy
-    proxy = property(__get_proxy)
+        @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 get_buddies_online(self):
-        cdef glib.GSList *iter
-        cdef blist.PurpleBuddy *buddy
-        buddies = []
-        iter = blist.c_purple_find_buddies(self.c_account, NULL)
-        while iter:
-            buddy = <blist.PurpleBuddy *> iter.data
-            if <blist.PurpleBuddy *>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)):
-                buddies += [buddy.name]
-            iter = iter.next
-        return buddies
+    def set_protocol(self, protocol):
+        """
+        Sets the account's protocol.
 
 
-    def get_protocol_options(self):
-        ''' FIXME: It is just a hack, to set the XMPP's options. '''
+        @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 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 accountopt.PurpleAccountOption *option
         cdef prefs.PurplePrefType type
-        cdef const_char *label_name
-        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
         cdef int int_value
         cdef glib.gboolean bool_value
-        iter = self.c_prpl_info.protocol_options
+
+        c_account = self._get_structure()
+
+        if c_account == NULL:
+            return False
+
+        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:
         while iter:
+
             option = <accountopt.PurpleAccountOption *> iter.data
             option = <accountopt.PurpleAccountOption *> 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)
+            type = accountopt.purple_account_option_get_type(option)
+            setting = <char *> accountopt.purple_account_option_get_setting(option)
 
 
-                # Google Talk default domain hackery!
-                if str_value == NULL and str(<char *> label_name) == "Connect server":
-                    str_value = "talk.google.com"
+            sett = str(<char *> setting)
+
+            if type == prefs.PURPLE_PREF_STRING:
 
 
-                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)
+                str_value = <char *> po[sett]
+                account.purple_account_set_string(c_account, setting, str_value)
 
             elif type == prefs.PURPLE_PREF_INT:
 
             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(<char *> setting) == "port":
-                        account.c_purple_account_set_int(self.c_account, setting, 443)
+
+                int_value = int(po[sett])
+                account.purple_account_set_int(c_account, setting, int_value)
 
             elif type == prefs.PURPLE_PREF_BOOLEAN:
 
             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(<char *> setting) == "old_ssl":
-                        account.c_purple_account_set_bool(self.c_account, setting, True)
+
+                bool_value = bool(po[sett])
+                account.purple_account_set_bool(c_account, setting, bool_value)
 
             elif type == prefs.PURPLE_PREF_STRING_LIST:
 
             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)
+
+                str_value = <char *> po[sett]
+                account.purple_account_set_string(c_account, setting, str_value)
 
             iter = iter.next
 
             iter = iter.next
+
+        return True
+
+    def set_password(self, password):
+        """
+        Sets the account's password.
+
+        @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
+
+    def new(self):
+        """
+        Creates a new account.
+
+        @return True if successful, False if account already exists
+        """
+        if self.__exists:
+            return False
+        else:
+            account.purple_account_new(self.__username, self.__protocol.id)
+            self.__exists = True
+            return True
+
+    def connect(self):
+        """
+        Connects to an account.
+
+        @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
+
+    def disconnect(self):
+        """
+        Disconnects from an account.
+
+        @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
+