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 __get_status_types(self):
226 cdef glib.GList *iter = NULL
227 cdef status.PurpleStatusType *c_statustype = NULL
229 cdef char *name = NULL
233 iter = account.purple_account_get_status_types(self._get_structure())
235 c_statustype = <status.PurpleStatusType *> iter.data
236 id = <char *> status.purple_status_type_get_id(c_statustype)
237 name = <char *> status.purple_status_type_get_name(c_statustype)
238 status_types.append((id, name))
244 status_types = property(__get_status_types)
246 def __get_active_status(self):
247 cdef status.PurpleStatus* c_status = NULL
248 cdef char *type = NULL
249 cdef char *name = NULL
250 cdef char *msg = NULL
253 c_status = <status.PurpleStatus*> account.purple_account_get_active_status(self._get_structure())
254 type = <char *> status.purple_status_get_id(c_status)
255 name = <char *> status.purple_status_get_name(c_status)
256 msg = <char *> status.purple_status_get_attr_string(c_status,
259 active['type'] = type
260 active['name'] = name
262 active['message'] = msg
267 active_status = property(__get_active_status)
269 def set_username(self, username):
271 Sets the account's username.
273 @param username The username
274 @return True if successful, False if account doesn't exists
277 account.purple_account_set_username(self._get_structure(), \
283 def set_protocol(self, protocol):
285 Sets the account's protocol.
287 @param protocol A Protocol class instance
288 @return True if successful, False if account doesn't exists
290 if protocol.exists and self.__exists:
291 account.purple_account_set_protocol_id(self._get_structure(), \
293 self.__protocol = protocol
298 def set_protocol_options(self, po):
300 @param po Dictionary {'setting': value, ...} options to be updated
301 @return True to success or False to failure
303 cdef glib.GList *iter
304 cdef account.PurpleAccount *c_account
305 cdef plugin.PurplePlugin *c_plugin
306 cdef prpl.PurplePluginProtocolInfo *prpl_info
307 cdef accountopt.PurpleAccountOption *option
308 cdef prefs.PurplePrefType type
312 cdef glib.gboolean bool_value
314 c_account = self._get_structure()
316 if c_account == NULL:
319 c_plugin = plugin.purple_plugins_find_with_id(self.__protocol.id)
320 prpl_info = plugin.PURPLE_PLUGIN_PROTOCOL_INFO(c_plugin)
321 iter = prpl_info.protocol_options
325 option = <accountopt.PurpleAccountOption *> iter.data
326 type = accountopt.purple_account_option_get_type(option)
327 setting = <char *> accountopt.purple_account_option_get_setting(option)
329 sett = str(<char *> setting)
331 if not po.has_key(sett):
335 if type == prefs.PURPLE_PREF_STRING:
337 str_value = <char *> po[sett]
338 account.purple_account_set_string(c_account, setting, str_value)
340 elif type == prefs.PURPLE_PREF_INT:
342 int_value = int(po[sett])
343 account.purple_account_set_int(c_account, setting, int_value)
345 elif type == prefs.PURPLE_PREF_BOOLEAN:
347 bool_value = bool(po[sett])
348 account.purple_account_set_bool(c_account, setting, bool_value)
350 elif type == prefs.PURPLE_PREF_STRING_LIST:
352 str_value = <char *> po[sett]
353 account.purple_account_set_string(c_account, setting, str_value)
359 def set_password(self, password):
361 Sets the account's password.
363 @param password The password
364 @return True if successful, False if account doesn't exists
367 account.purple_account_set_password(self._get_structure(), \
373 def set_alias(self, alias):
375 Sets the account's alias
377 @param alias The alias
378 @return True if successful, False if account doesn't exists
381 account.purple_account_set_alias(self._get_structure(), \
387 def set_user_info(self, user_info):
389 Sets the account's user information
391 @param user_info The user information
392 @return True if successful, False if account doesn't exists
395 account.purple_account_set_user_info(self._get_structure(), \
401 def set_remember_password(self, remember_password):
403 Sets whether or not this account should save its password.
405 @param remember_password True if should remember the password,
407 @return True if successful, False if account doesn't exists
410 account.purple_account_set_remember_password( \
411 self._get_structure(), remember_password)
416 def set_enabled(self, value):
418 Sets wheter or not this account is enabled.
420 @param value True if it is enabled, or False otherwise
421 @return True if successful, False if account doesn't exists
424 account.purple_account_set_enabled(self._get_structure(), \
425 self.__core.ui_name, bool(value))
432 Creates a new account.
434 @return True if successful, False if account already exists
439 account.purple_accounts_add(account.purple_account_new( \
440 self.__username, self.__protocol.id))
447 Removes an existing account.
449 @return True if successful, False if account doesn't exists
452 account.purple_accounts_delete(self._get_structure())
460 Connects to an account.
462 @return True if successful, False if account doesn't exists
465 account.purple_account_connect(self._get_structure())
470 def disconnect(self):
472 Disconnects from an account.
474 @return True if successful, False if account doesn't exists
477 account.purple_account_disconnect(self._get_structure())
482 def add_buddy(self, name, alias=None, group=None):
484 Adds a buddy to account's buddy list.
486 @param name Buddy name
487 @param alias Buddy alias (optional)
488 @return True if successfull, False otherwise
490 cdef blist.PurpleBuddy *c_buddy = NULL
491 cdef blist.PurpleGroup *c_group = NULL
492 cdef char *c_alias = NULL
499 if self.__exists and \
500 account.purple_account_is_connected(self._get_structure()):
501 if blist.purple_find_buddy(self._get_structure(), name):
505 c_group = blist.purple_find_group(group)
507 c_group = blist.purple_group_new(group)
509 c_buddy = blist.purple_buddy_new(self._get_structure(), \
514 blist.purple_blist_add_buddy(c_buddy, NULL, c_group, NULL)
515 account.purple_account_add_buddy(self._get_structure(), c_buddy)
517 blist.purple_blist_alias_buddy(c_buddy, c_alias)
518 server.serv_alias_buddy(c_buddy)
525 def remove_buddy(self, name):
527 Removes a buddy from account's buddy list.
529 @param name Buddy name
530 @return True if successful, False otherwise
532 cdef blist.PurpleBuddy *c_buddy = NULL
533 cdef blist.PurpleGroup *c_group = NULL
535 if self.__exists and \
536 account.purple_account_is_connected(self._get_structure()):
537 c_buddy = blist.purple_find_buddy(self._get_structure(), name)
541 c_group = blist.purple_buddy_get_group(c_buddy)
543 account.purple_account_remove_buddy(self._get_structure(), \
545 blist.purple_blist_remove_buddy(c_buddy)
550 def get_buddies_online(self):
551 cdef glib.GSList *iter = NULL
552 cdef blist.PurpleBuddy *c_buddy = NULL
553 cdef char *c_alias = NULL
555 if self.__exists and \
556 account.purple_account_is_connected(self._get_structure()):
557 iter = blist.purple_find_buddies(self._get_structure(), NULL)
562 c_buddy = <blist.PurpleBuddy *> iter.data
563 if <blist.PurpleBuddy *> c_buddy and \
564 status.purple_presence_is_online( \
565 blist.purple_buddy_get_presence(c_buddy)):
566 name = <char *> blist.purple_buddy_get_name(c_buddy)
568 new_buddy = Buddy(name, self)
570 c_alias = <char *> blist.purple_buddy_get_alias_only(c_buddy)
572 new_buddy.set_alias(c_alias)
574 buddies_list.append(new_buddy)
580 def request_add_buddy(self, buddy_username, buddy_alias):
582 blist.purple_blist_request_add_buddy(self._get_structure(), \
583 buddy_username, NULL, buddy_alias)
585 blist.purple_blist_request_add_buddy(self._get_structure(), \
586 buddy_username, NULL, NULL)
588 def set_active_status(self, type, msg=None):
589 cdef status.PurpleStatusType *c_statustype = NULL
593 account.purple_account_set_status(self._get_structure(),
594 <char *> type, True, "message", <char *> msg, NULL)
596 account.purple_account_set_status(self._get_structure(),
597 <char *> type, True, NULL)
602 def set_status_message(self, type, msg):
603 cdef status.PurpleStatus* c_status = NULL
604 cdef status.PurpleStatusType *c_statustype = NULL
606 if self.__exists and msg:
607 c_status = account.purple_account_get_status(self._get_structure(),
609 status.purple_status_set_attr_string(c_status, "message", msg)