Added request_add_buddy.
[python-purple] / account.pyx
index bd2eb44..7240de2 100644 (file)
 
 cimport purple
 
 
 cimport purple
 
-from protocol import Protocol
-
 cdef class Account:
     """
     Account class
     @param username
 cdef class Account:
     """
     Account class
     @param username
-    @param protocol_id
+    @param protocol Protocol class instance
+    @param core Purple class instance
     """
 
     """
 
-    def __init__(self, username, protocol_id):
+    cdef object __username
+    cdef object __protocol
+    cdef object __core
+    cdef object __exists
+
+    def __init__(self, username, protocol, core):
         self.__username = username
         self.__username = username
-        self.__protocol = Protocol(self, protocol_id)
+        self.__protocol = protocol
+        self.__core = core
 
 
-        if self._get_structure() == NULL:
-            self.__exists = False
-        else:
+        if protocol.exists and self._get_structure() != NULL:
             self.__exists = True
             self.__exists = True
+        else:
+            self.__exists = False
 
     cdef account.PurpleAccount *_get_structure(self):
 
     cdef account.PurpleAccount *_get_structure(self):
-        return account.purple_accounts_find(self.username, \
-                self.protocol_id)
+        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
+    is_connected = property(__is_connected)
+
+    def __is_connecting(self):
+        if self.__exists:
+            return account.purple_account_is_connecting(self._get_structure())
+        else:
+            return None
+    is_connecting = property(__is_connecting)
+
+    def __is_disconnected(self):
+        if self.__exists:
+            return account.purple_account_is_disconnected( \
+                    self._get_structure())
+        else:
+            return None
+    is_disconnected = property(__is_disconnected)
+
+    def __get_core(self):
+        return self.__core
+    core = property(__get_core)
 
     def __get_exists(self):
         return self.__exists
 
     def __get_exists(self):
         return self.__exists
@@ -58,18 +89,84 @@ cdef class Account:
             return self.__username
     username = property(__get_username)
 
             return self.__username
     username = property(__get_username)
 
-    def __get_protocol_id(self):
-        cdef char *protocol_id = NULL
-        if self.__exists:
-            protocol_id = <char *> account.purple_account_get_protocol_id( \
-                    self._get_structure())
-            if protocol_id:
-                return protocol_id
-            else:
-                return None
-        else:
-            return self.protocol_id
-    protocol_id = property(__get_protocol_id)
+    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
+
+        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
 
     def __get_password(self):
         cdef char *password = NULL
@@ -82,14 +179,7 @@ cdef class Account:
                 return None
         else:
             return None
                 return None
         else:
             return None
-    def __set_password(self, password):
-        if self.__exists:
-            account.purple_account_set_password(self._get_structure(), \
-                    password)
-            return True
-        else:
-            return False
-    password = property(__get_password, __set_password)
+    password = property(__get_password)
 
     def __get_alias(self):
         cdef char *alias = NULL
 
     def __get_alias(self):
         cdef char *alias = NULL
@@ -101,14 +191,7 @@ cdef class Account:
                 return None
         else:
             return None
                 return None
         else:
             return None
-    def __set_alias(self, alias):
-        if self.__exists:
-            account.purple_account_set_alias(self._get_structure(), \
-                    alias)
-            return True
-        else:
-            return False
-    alias = property(__get_alias, __set_alias)
+    alias = property(__get_alias)
 
     def __get_user_info(self):
         cdef char *user_info = NULL
 
     def __get_user_info(self):
         cdef char *user_info = NULL
@@ -120,14 +203,7 @@ cdef class Account:
                 return None
         else:
             return None
                 return None
         else:
             return None
-    def __set_user_info(self, user_info):
-        if self.__exists:
-            account.purple_account_set_user_info(self._get_structure(), \
-                    user_info)
-            return True
-        else:
-            return False
-    user_info = property(__get_user_info, __set_user_info)
+    user_info = property(__get_user_info)
 
     def __get_remember_password(self):
         if self.__exists:
 
     def __get_remember_password(self):
         if self.__exists:
@@ -135,17 +211,23 @@ cdef class Account:
                     self._get_structure())
         else:
             return None
                     self._get_structure())
         else:
             return None
-    def __set_remember_password(self, remember_password):
+    remember_password = property(__get_remember_password)
+
+    def __get_enabled(self):
         if self.__exists:
         if self.__exists:
-            account.purple_account_set_remember_password( \
-                self._get_structure(), remember_password)
-            return True
+            return account.purple_account_get_enabled(self._get_structure(), \
+                    self.__core.ui_name)
         else:
         else:
-            return False
-    remember_password = property(__get_remember_password, \
-            __set_remember_password)
+            return None
+    enabled = property(__get_enabled)
 
     def set_username(self, username):
 
     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)
         if self.__exists:
             account.purple_account_set_username(self._get_structure(), \
                     username)
@@ -153,17 +235,303 @@ cdef class Account:
         else:
             return False
 
         else:
             return False
 
-    def set_protocol_id(self, protocol_id):
+    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 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 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:
+
+            option = <accountopt.PurpleAccountOption *> iter.data
+            type = accountopt.purple_account_option_get_type(option)
+            setting = <char *> accountopt.purple_account_option_get_setting(option)
+
+            sett = str(<char *> setting)
+
+            if not po.has_key(sett):
+                iter = iter.next
+                continue
+
+            if type == prefs.PURPLE_PREF_STRING:
+
+                str_value = <char *> po[sett]
+                account.purple_account_set_string(c_account, setting, str_value)
+
+            elif type == prefs.PURPLE_PREF_INT:
+
+                int_value = int(po[sett])
+                account.purple_account_set_int(c_account, setting, int_value)
+
+            elif type == prefs.PURPLE_PREF_BOOLEAN:
+
+                bool_value = bool(po[sett])
+                account.purple_account_set_bool(c_account, setting, bool_value)
+
+            elif type == prefs.PURPLE_PREF_STRING_LIST:
+
+                str_value = <char *> po[sett]
+                account.purple_account_set_string(c_account, setting, str_value)
+
+            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:
         if self.__exists:
-            self.__protocol._set_protocol_id(protocol_id)
+            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):
             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:
         if self.__exists:
             return False
         else:
-            account.purple_account_new(self.username, self.protocol_id)
+            account.purple_accounts_add(account.purple_account_new( \
+                    self.__username, self.__protocol.id))
+
             self.__exists = True
             return True
             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
+
+    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
+
+    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
+
+        if alias:
+            c_alias = alias
+        else:
+            c_alias = NULL
+
+        if self.__exists and \
+                account.purple_account_is_connected(self._get_structure()):
+            if blist.purple_find_buddy(self._get_structure(), name):
+                return False
+
+            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)
+            return True
+
+        else:
+            return None
+
+    def remove_buddy(self, name):
+        """
+        Removes a buddy from account's buddy list.
+
+        @param name Buddy name
+        @return True if successful, False otherwise
+        """
+        cdef blist.PurpleBuddy *c_buddy = NULL
+        cdef blist.PurpleGroup *c_group = NULL
+
+        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 = NULL
+        cdef blist.PurpleBuddy *c_buddy = NULL
+        cdef char *c_alias = NULL
+
+        if self.__exists and \
+                account.purple_account_is_connected(self._get_structure()):
+            iter = blist.purple_find_buddies(self._get_structure(), NULL)
+
+            buddies_list = []
+            while iter:
+                c_alias = NULL
+                c_buddy = <blist.PurpleBuddy *> iter.data
+                if <blist.PurpleBuddy *> c_buddy and \
+                        status.purple_presence_is_online( \
+                                blist.purple_buddy_get_presence(c_buddy)):
+                    name = <char *> blist.purple_buddy_get_name(c_buddy)
+
+                    new_buddy = Buddy(name, self)
+
+                    c_alias = <char *> blist.purple_buddy_get_alias_only(c_buddy)
+                    if c_alias:
+                        new_buddy.set_alias(c_alias)
+
+                    buddies_list.append(new_buddy)
+                iter = iter.next
+            return buddies_list
+        else:
+            return None
+
+    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)