git.maemo.org Git - python-purple/blob - account.pyx

   1 #
   2 #  Copyright (c) 2008 INdT - Instituto Nokia de Tecnologia
   3 #
   4 #  This file is part of python-purple.
   5 #
   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.
  10 #
  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.
  15 #
  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/>.
  18 #
  19
  20 cimport purple
  21
  22 cdef class Account:
  23     """
  24     Account class
  25     @param username
  26     @param protocol Protocol class instance
  27     @param core Purple class instance
  28     """
  29
  30     cdef object __username
  31     cdef object __protocol
  32     cdef object __core
  33     cdef object __exists
  34
  35     def __init__(self, username, protocol, core):
  36         self.__username = username
  37         self.__protocol = protocol
  38         self.__core = core
  39
  40         if protocol.exists and self._get_structure() != NULL:
  41             self.__exists = True
  42         else:
  43             self.__exists = False
  44
  45     cdef account.PurpleAccount *_get_structure(self):
  46         return account.purple_accounts_find(self.__username, \
  47                 self.__protocol.id)
  48
  49     def __is_connected(self):
  50         if self.__exists:
  51             return account.purple_account_is_connected(self._get_structure())
  52         else:
  53             return None
  54     is_connected = property(__is_connected)
  55
  56     def __is_connecting(self):
  57         if self.__exists:
  58             return account.purple_account_is_connecting(self._get_structure())
  59         else:
  60             return None
  61     is_connecting = property(__is_connecting)
  62
  63     def __is_disconnected(self):
  64         if self.__exists:
  65             return account.purple_account_is_disconnected( \
  66                     self._get_structure())
  67         else:
  68             return None
  69     is_disconnected = property(__is_disconnected)
  70
  71     def __get_core(self):
  72         return self.__core
  73     core = property(__get_core)
  74
  75     def __get_exists(self):
  76         return self.__exists
  77     exists = property(__get_exists)
  78
  79     def __get_username(self):
  80         cdef char *username = NULL
  81         if self.__exists:
  82             username = <char *> account.purple_account_get_username( \
  83                     self._get_structure())
  84             if username:
  85                 return username
  86             else:
  87                 return None
  88         else:
  89             return self.__username
  90     username = property(__get_username)
  91
  92     def __get_protocol(self):
  93         return self.__protocol
  94     protocol = property(__get_protocol)
  95
  96     def _get_protocol_options(self):
  97         """
  98         @return Dictionary {'setting': value, ...}
  99         """
 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
 107         cdef char *str_value
 108         cdef char *setting
 109         cdef int int_value
 110         cdef glib.gboolean bool_value
 111
 112         c_account = self._get_structure()
 113
 114         if c_account == NULL:
 115             return None
 116
 117         po = {}
 118
 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
 122
 123         while iter:
 124
 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)
 129
 130             sett = str(<char *> setting)
 131
 132             if type == prefs.PURPLE_PREF_STRING:
 133
 134                 str_value = <char *> accountopt.purple_account_option_get_default_string(option)
 135
 136                 # Google Talk default domain hackery!
 137                 if str_value == NULL and str(<char *> label_name) == "Connect server":
 138                     str_value = "talk.google.com"
 139                 str_value = <char *> account.purple_account_get_string(c_account, setting, str_value)
 140
 141                 val = str(<char *> str_value)
 142
 143             elif type == prefs.PURPLE_PREF_INT:
 144
 145                 int_value = accountopt.purple_account_option_get_default_int(option)
 146                 int_value = account.purple_account_get_int(c_account, setting, int_value)
 147
 148                 val = int(int_value)
 149
 150             elif type == prefs.PURPLE_PREF_BOOLEAN:
 151
 152                 bool_value = accountopt.purple_account_option_get_default_bool(option)
 153                 bool_value = account.purple_account_get_bool(c_account, setting, bool_value)
 154
 155                 val = bool(bool_value)
 156
 157             elif type == prefs.PURPLE_PREF_STRING_LIST:
 158
 159                 str_value = <char *> accountopt.purple_account_option_get_default_list_value(option)
 160                 str_value = <char *> account.purple_account_get_string(c_account, setting, str_value)
 161
 162                 val = str(<char *> str_value)
 163
 164             iter = iter.next
 165
 166             po[sett] = val
 167
 168         return po
 169     protocol_options = property(_get_protocol_options)
 170
 171     def __get_password(self):
 172         cdef char *password = NULL
 173         if self.__exists:
 174             password = <char *> account.purple_account_get_password( \
 175                     self._get_structure())
 176             if password:
 177                 return password
 178             else:
 179                 return None
 180         else:
 181             return None
 182     password = property(__get_password)
 183
 184     def __get_alias(self):
 185         cdef char *alias = NULL
 186         if self.__exists:
 187             alias = <char *> account.purple_account_get_alias(self._get_structure())
 188             if alias:
 189                 return alias
 190             else:
 191                 return None
 192         else:
 193             return None
 194     alias = property(__get_alias)
 195
 196     def __get_user_info(self):
 197         cdef char *user_info = NULL
 198         if self.__exists:
 199             user_info = <char *> account.purple_account_get_user_info(self._get_structure())
 200             if user_info:
 201                 return user_info
 202             else:
 203                 return None
 204         else:
 205             return None
 206     user_info = property(__get_user_info)
 207
 208     def __get_remember_password(self):
 209         if self.__exists:
 210             return account.purple_account_get_remember_password( \
 211                     self._get_structure())
 212         else:
 213             return None
 214     remember_password = property(__get_remember_password)
 215
 216     def __get_enabled(self):
 217         if self.__exists:
 218             return account.purple_account_get_enabled(self._get_structure(), \
 219                     self.__core.ui_name)
 220         else:
 221             return None
 222     enabled = property(__get_enabled)
 223
 224     def set_username(self, username):
 225         """
 226         Sets the account's username.
 227
 228         @param username The username
 229         @return True if successful, False if account doesn't exists
 230         """
 231         if self.__exists:
 232             account.purple_account_set_username(self._get_structure(), \
 233                     username)
 234             return True
 235         else:
 236             return False
 237
 238     def set_protocol(self, protocol):
 239         """
 240         Sets the account's protocol.
 241
 242         @param protocol A Protocol class instance
 243         @return True if successful, False if account doesn't exists
 244         """
 245         if protocol.exists and self.__exists:
 246             account.purple_account_set_protocol_id(self._get_structure(), \
 247                         protocol.id)
 248             self.__protocol = protocol
 249             return True
 250         else:
 251             return False
 252
 253     def set_protocol_options(self, po):
 254         """
 255         @param po Dictionary {'setting': value, ...} options to be updated
 256         @return True to success or False to failure
 257         """
 258         cdef glib.GList *iter
 259         cdef account.PurpleAccount *c_account
 260         cdef plugin.PurplePlugin *c_plugin
 261         cdef prpl.PurplePluginProtocolInfo *prpl_info
 262         cdef accountopt.PurpleAccountOption *option
 263         cdef prefs.PurplePrefType type
 264         cdef char *str_value
 265         cdef char *setting
 266         cdef int int_value
 267         cdef glib.gboolean bool_value
 268
 269         c_account = self._get_structure()
 270
 271         if c_account == NULL:
 272             return False
 273
 274         c_plugin = plugin.purple_plugins_find_with_id(self.__protocol.id)
 275         prpl_info = plugin.PURPLE_PLUGIN_PROTOCOL_INFO(c_plugin)
 276         iter = prpl_info.protocol_options
 277
 278         while iter:
 279
 280             option = <accountopt.PurpleAccountOption *> iter.data
 281             type = accountopt.purple_account_option_get_type(option)
 282             setting = <char *> accountopt.purple_account_option_get_setting(option)
 283
 284             sett = str(<char *> setting)
 285
 286             if not po.has_key(sett):
 287                 iter = iter.next
 288                 continue
 289
 290             if type == prefs.PURPLE_PREF_STRING:
 291
 292                 str_value = <char *> po[sett]
 293                 account.purple_account_set_string(c_account, setting, str_value)
 294
 295             elif type == prefs.PURPLE_PREF_INT:
 296
 297                 int_value = int(po[sett])
 298                 account.purple_account_set_int(c_account, setting, int_value)
 299
 300             elif type == prefs.PURPLE_PREF_BOOLEAN:
 301
 302                 bool_value = bool(po[sett])
 303                 account.purple_account_set_bool(c_account, setting, bool_value)
 304
 305             elif type == prefs.PURPLE_PREF_STRING_LIST:
 306
 307                 str_value = <char *> po[sett]
 308                 account.purple_account_set_string(c_account, setting, str_value)
 309
 310             iter = iter.next
 311
 312         return True
 313
 314     def set_password(self, password):
 315         """
 316         Sets the account's password.
 317
 318         @param password The password
 319         @return True if successful, False if account doesn't exists
 320         """
 321         if self.__exists:
 322             account.purple_account_set_password(self._get_structure(), \
 323                     password)
 324             return True
 325         else:
 326             return False
 327
 328     def set_alias(self, alias):
 329         """
 330         Sets the account's alias
 331
 332         @param alias The alias
 333         @return True if successful, False if account doesn't exists
 334         """
 335         if self.__exists:
 336             account.purple_account_set_alias(self._get_structure(), \
 337                     alias)
 338             return True
 339         else:
 340             return False
 341
 342     def set_user_info(self, user_info):
 343         """
 344         Sets the account's user information
 345
 346         @param user_info The user information
 347         @return True if successful, False if account doesn't exists
 348         """
 349         if self.__exists:
 350             account.purple_account_set_user_info(self._get_structure(), \
 351                     user_info)
 352             return True
 353         else:
 354             return False
 355
 356     def set_remember_password(self, remember_password):
 357         """
 358         Sets whether or not this account should save its password.
 359
 360         @param remember_password True if should remember the password,
 361                                  or False otherwise
 362         @return True if successful, False if account doesn't exists
 363         """
 364         if self.__exists:
 365             account.purple_account_set_remember_password( \
 366                 self._get_structure(), remember_password)
 367             return True
 368         else:
 369             return False
 370
 371     def set_enabled(self, value):
 372         """
 373         Sets wheter or not this account is enabled.
 374
 375         @param value True if it is enabled, or False otherwise
 376         @return True if successful, False if account doesn't exists
 377         """
 378         if self.__exists:
 379             account.purple_account_set_enabled(self._get_structure(), \
 380                     self.__core.ui_name, bool(value))
 381             return True
 382         else:
 383             return False
 384
 385     def new(self):
 386         """
 387         Creates a new account.
 388
 389         @return True if successful, False if account already exists
 390         """
 391         if self.__exists:
 392             return False
 393         else:
 394             # FIXME: Using purple_accounts_add(...) to save to xml
 395             #   I think we could improve this ..
 396             account.purple_accounts_add(account.purple_account_new( \
 397                     self.__username, self.__protocol.id))
 398
 399             self.__exists = True
 400             return True
 401
 402     def connect(self):
 403         """
 404         Connects to an account.
 405
 406         @return True if successful, False if account doesn't exists
 407         """
 408         if self.__exists:
 409             account.purple_account_connect(self._get_structure())
 410             return True
 411         else:
 412             return False
 413
 414     def disconnect(self):
 415         """
 416         Disconnects from an account.
 417
 418         @return True if successful, False if account doesn't exists
 419         """
 420         if self.__exists:
 421             account.purple_account_disconnect(self._get_structure())
 422             return True
 423         else:
 424             return False
 425
 426     def add_buddy(self, name, alias=None, group=None):
 427         """
 428         Adds a buddy to account's buddy list.
 429
 430         @param name  Buddy name
 431         @param alias Buddy alias (optional)
 432         @return True if successfull, False otherwise
 433         """
 434         cdef blist.PurpleBuddy *c_buddy = NULL
 435         cdef blist.PurpleGroup *c_group = NULL
 436         cdef char *c_alias = NULL
 437
 438         if alias:
 439             c_alias = alias
 440         else:
 441             c_alias = NULL
 442
 443         if self.__exists and \
 444                 account.purple_account_is_connected(self._get_structure()):
 445             if blist.purple_find_buddy(self._get_structure(), name):
 446                 return False
 447
 448             if group:
 449                 c_group = blist.purple_find_group(group)
 450                 if c_group == NULL:
 451                     c_group = blist.purple_group_new(group)
 452
 453             c_buddy = blist.purple_buddy_new(self._get_structure(), \
 454                     name, c_alias)
 455             if c_buddy == NULL:
 456                 return False
 457
 458             blist.purple_blist_add_buddy(c_buddy, NULL, c_group, NULL)
 459             account.purple_account_add_buddy(self._get_structure(), c_buddy)
 460             return True
 461
 462         else:
 463             return None
 464
 465     def remove_buddy(self, name):
 466         """
 467         Removes a buddy from account's buddy list.
 468
 469         @param name Buddy name
 470         @return True if successful, False otherwise
 471         """
 472         cdef blist.PurpleBuddy *c_buddy = NULL
 473         cdef blist.PurpleGroup *c_group = NULL
 474
 475         if self.__exists and \
 476                 account.purple_account_is_connected(self._get_structure()):
 477             c_buddy = blist.purple_find_buddy(self._get_structure(), name)
 478             if c_buddy == NULL:
 479                 return False
 480
 481             c_group = blist.purple_buddy_get_group(c_buddy)
 482
 483             account.purple_account_remove_buddy(self._get_structure(), \
 484                     c_buddy, c_group)
 485             blist.purple_blist_remove_buddy(c_buddy)
 486             return True
 487         else:
 488             return None
 489
 490     def get_buddies_online(self):
 491         cdef glib.GSList *iter = NULL
 492         cdef blist.PurpleBuddy *c_buddy = NULL
 493         cdef char *c_alias = NULL
 494
 495         if self.__exists and \
 496                 account.purple_account_is_connected(self._get_structure()):
 497             iter = blist.purple_find_buddies(self._get_structure(), NULL)
 498
 499             buddies_list = []
 500             while iter:
 501                 c_alias = NULL
 502                 c_buddy = <blist.PurpleBuddy *> iter.data
 503                 if <blist.PurpleBuddy *> c_buddy and \
 504                         status.purple_presence_is_online( \
 505                                 blist.purple_buddy_get_presence(c_buddy)):
 506                     name = <char *> blist.purple_buddy_get_name(c_buddy)
 507
 508                     new_buddy = Buddy(name, self)
 509
 510                     c_alias = <char *> blist.purple_buddy_get_alias_only(c_buddy)
 511                     if c_alias:
 512                         new_buddy.set_alias(c_alias)
 513
 514                     buddies_list.append(new_buddy)
 515                 iter = iter.next
 516             return buddies_list
 517         else:
 518             return None