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/>.
26 @param protocol Protocol class instance
27 @param core Purple class instance
30 cdef object __username
31 cdef object __protocol
35 def __init__(self, username, protocol, core):
36 self.__username = username
37 self.__protocol = protocol
40 if protocol.exists and self._get_structure() != NULL:
45 cdef account.PurpleAccount *_get_structure(self):
46 return account.purple_accounts_find(self.__username, \
49 def __is_connected(self):
51 return account.purple_account_is_connected(self._get_structure())
54 is_connected = property(__is_connected)
56 def __is_connecting(self):
58 return account.purple_account_is_connecting(self._get_structure())
61 is_connecting = property(__is_connecting)
63 def __is_disconnected(self):
65 return account.purple_account_is_disconnected( \
66 self._get_structure())
69 is_disconnected = property(__is_disconnected)
73 core = property(__get_core)
75 def __get_exists(self):
77 exists = property(__get_exists)
79 def __get_username(self):
80 cdef char *username = NULL
82 username = <char *> account.purple_account_get_username( \
83 self._get_structure())
89 return self.__username
90 username = property(__get_username)
92 def __get_protocol(self):
93 return self.__protocol
94 protocol = property(__get_protocol)
96 def _get_protocol_options(self):
98 @return Dictionary {'setting': value, ...}
100 cdef glib.GList *iter
101 cdef account.PurpleAccount *c_account
102 cdef plugin.PurplePlugin *c_plugin
103 cdef prpl.PurplePluginProtocolInfo *prpl_info
104 cdef accountopt.PurpleAccountOption *option
105 cdef prefs.PurplePrefType type
106 cdef char *label_name
110 cdef glib.gboolean bool_value
112 c_account = self._get_structure()
114 if c_account == NULL:
119 c_plugin = plugin.purple_plugins_find_with_id(self.__protocol.id)
120 prpl_info = plugin.PURPLE_PLUGIN_PROTOCOL_INFO(c_plugin)
121 iter = prpl_info.protocol_options
125 option = <accountopt.PurpleAccountOption *> iter.data
126 type = accountopt.purple_account_option_get_type(option)
127 label_name = <char *> accountopt.purple_account_option_get_text(option)
128 setting = <char *> accountopt.purple_account_option_get_setting(option)
130 sett = str(<char *> setting)
132 if type == prefs.PURPLE_PREF_STRING:
134 str_value = <char *> accountopt.purple_account_option_get_default_string(option)
136 # Hack to set string "" as default value to Account options when
137 # the default value of the protocol is NULL
138 if str_value == NULL:
140 str_value = <char *> account.purple_account_get_string(c_account, setting, str_value)
142 val = str(<char *> str_value)
144 elif type == prefs.PURPLE_PREF_INT:
146 int_value = accountopt.purple_account_option_get_default_int(option)
147 int_value = account.purple_account_get_int(c_account, setting, int_value)
151 elif type == prefs.PURPLE_PREF_BOOLEAN:
153 bool_value = accountopt.purple_account_option_get_default_bool(option)
154 bool_value = account.purple_account_get_bool(c_account, setting, bool_value)
156 val = bool(bool_value)
158 elif type == prefs.PURPLE_PREF_STRING_LIST:
160 str_value = <char *> accountopt.purple_account_option_get_default_list_value(option)
161 str_value = <char *> account.purple_account_get_string(c_account, setting, str_value)
163 val = str(<char *> str_value)
170 protocol_options = property(_get_protocol_options)
172 def __get_password(self):
173 cdef char *password = NULL
175 password = <char *> account.purple_account_get_password( \
176 self._get_structure())
183 password = property(__get_password)
185 def __get_alias(self):
186 cdef char *alias = NULL
188 alias = <char *> account.purple_account_get_alias(self._get_structure())
195 alias = property(__get_alias)
197 def __get_user_info(self):
198 cdef char *user_info = NULL
200 user_info = <char *> account.purple_account_get_user_info(self._get_structure())
207 user_info = property(__get_user_info)
209 def __get_remember_password(self):
211 return account.purple_account_get_remember_password( \
212 self._get_structure())
215 remember_password = property(__get_remember_password)
217 def __get_enabled(self):
219 return account.purple_account_get_enabled(self._get_structure(), \
223 enabled = property(__get_enabled)
225 def set_username(self, username):
227 Sets the account's username.
229 @param username The username
230 @return True if successful, False if account doesn't exists
233 account.purple_account_set_username(self._get_structure(), \
239 def set_protocol(self, protocol):
241 Sets the account's protocol.
243 @param protocol A Protocol class instance
244 @return True if successful, False if account doesn't exists
246 if protocol.exists and self.__exists:
247 account.purple_account_set_protocol_id(self._get_structure(), \
249 self.__protocol = protocol
254 def set_protocol_options(self, po):
256 @param po Dictionary {'setting': value, ...} options to be updated
257 @return True to success or False to failure
259 cdef glib.GList *iter
260 cdef account.PurpleAccount *c_account
261 cdef plugin.PurplePlugin *c_plugin
262 cdef prpl.PurplePluginProtocolInfo *prpl_info
263 cdef accountopt.PurpleAccountOption *option
264 cdef prefs.PurplePrefType type
268 cdef glib.gboolean bool_value
270 c_account = self._get_structure()
272 if c_account == NULL:
275 c_plugin = plugin.purple_plugins_find_with_id(self.__protocol.id)
276 prpl_info = plugin.PURPLE_PLUGIN_PROTOCOL_INFO(c_plugin)
277 iter = prpl_info.protocol_options
281 option = <accountopt.PurpleAccountOption *> iter.data
282 type = accountopt.purple_account_option_get_type(option)
283 setting = <char *> accountopt.purple_account_option_get_setting(option)
285 sett = str(<char *> setting)
287 if not po.has_key(sett):
291 if type == prefs.PURPLE_PREF_STRING:
293 str_value = <char *> po[sett]
294 account.purple_account_set_string(c_account, setting, str_value)
296 elif type == prefs.PURPLE_PREF_INT:
298 int_value = int(po[sett])
299 account.purple_account_set_int(c_account, setting, int_value)
301 elif type == prefs.PURPLE_PREF_BOOLEAN:
303 bool_value = bool(po[sett])
304 account.purple_account_set_bool(c_account, setting, bool_value)
306 elif type == prefs.PURPLE_PREF_STRING_LIST:
308 str_value = <char *> po[sett]
309 account.purple_account_set_string(c_account, setting, str_value)
315 def set_password(self, password):
317 Sets the account's password.
319 @param password The password
320 @return True if successful, False if account doesn't exists
323 account.purple_account_set_password(self._get_structure(), \
329 def set_alias(self, alias):
331 Sets the account's alias
333 @param alias The alias
334 @return True if successful, False if account doesn't exists
337 account.purple_account_set_alias(self._get_structure(), \
343 def set_user_info(self, user_info):
345 Sets the account's user information
347 @param user_info The user information
348 @return True if successful, False if account doesn't exists
351 account.purple_account_set_user_info(self._get_structure(), \
357 def set_remember_password(self, remember_password):
359 Sets whether or not this account should save its password.
361 @param remember_password True if should remember the password,
363 @return True if successful, False if account doesn't exists
366 account.purple_account_set_remember_password( \
367 self._get_structure(), remember_password)
372 def set_enabled(self, value):
374 Sets wheter or not this account is enabled.
376 @param value True if it is enabled, or False otherwise
377 @return True if successful, False if account doesn't exists
380 account.purple_account_set_enabled(self._get_structure(), \
381 self.__core.ui_name, bool(value))
388 Creates a new account.
390 @return True if successful, False if account already exists
395 account.purple_accounts_add(account.purple_account_new( \
396 self.__username, self.__protocol.id))
403 Removes an existing account.
405 @return True if successful, False if account doesn't exists
408 account.purple_accounts_delete(self._get_structure())
416 Connects to an account.
418 @return True if successful, False if account doesn't exists
421 account.purple_account_connect(self._get_structure())
426 def disconnect(self):
428 Disconnects from an account.
430 @return True if successful, False if account doesn't exists
433 account.purple_account_disconnect(self._get_structure())
438 def add_buddy(self, name, alias=None, group=None):
440 Adds a buddy to account's buddy list.
442 @param name Buddy name
443 @param alias Buddy alias (optional)
444 @return True if successfull, False otherwise
446 cdef blist.PurpleBuddy *c_buddy = NULL
447 cdef blist.PurpleGroup *c_group = NULL
448 cdef char *c_alias = NULL
455 if self.__exists and \
456 account.purple_account_is_connected(self._get_structure()):
457 if blist.purple_find_buddy(self._get_structure(), name):
461 c_group = blist.purple_find_group(group)
463 c_group = blist.purple_group_new(group)
465 c_buddy = blist.purple_buddy_new(self._get_structure(), \
470 blist.purple_blist_add_buddy(c_buddy, NULL, c_group, NULL)
471 account.purple_account_add_buddy(self._get_structure(), c_buddy)
473 blist.purple_blist_alias_buddy(c_buddy, c_alias)
474 server.serv_alias_buddy(c_buddy)
481 def remove_buddy(self, name):
483 Removes a buddy from account's buddy list.
485 @param name Buddy name
486 @return True if successful, False otherwise
488 cdef blist.PurpleBuddy *c_buddy = NULL
489 cdef blist.PurpleGroup *c_group = NULL
491 if self.__exists and \
492 account.purple_account_is_connected(self._get_structure()):
493 c_buddy = blist.purple_find_buddy(self._get_structure(), name)
497 c_group = blist.purple_buddy_get_group(c_buddy)
499 account.purple_account_remove_buddy(self._get_structure(), \
501 blist.purple_blist_remove_buddy(c_buddy)
506 def get_buddies_online(self):
507 cdef glib.GSList *iter = NULL
508 cdef blist.PurpleBuddy *c_buddy = NULL
509 cdef char *c_alias = NULL
511 if self.__exists and \
512 account.purple_account_is_connected(self._get_structure()):
513 iter = blist.purple_find_buddies(self._get_structure(), NULL)
518 c_buddy = <blist.PurpleBuddy *> iter.data
519 if <blist.PurpleBuddy *> c_buddy and \
520 status.purple_presence_is_online( \
521 blist.purple_buddy_get_presence(c_buddy)):
522 name = <char *> blist.purple_buddy_get_name(c_buddy)
524 new_buddy = Buddy(name, self)
526 c_alias = <char *> blist.purple_buddy_get_alias_only(c_buddy)
528 new_buddy.set_alias(c_alias)
530 buddies_list.append(new_buddy)
536 def request_add_buddy(self, buddy_username, buddy_alias):
538 blist.purple_blist_request_add_buddy(self._get_structure(), \
539 buddy_username, NULL, buddy_alias)
541 blist.purple_blist_request_add_buddy(self._get_structure(), \
542 buddy_username, NULL, NULL)