/**

 * @file account.h Account API

 * @ingroup core

 * @see @ref account-signals

 */

/* purple

 *

 * Purple is the legal property of its developers, whose names are too numerous

 * to list here.  Please refer to the COPYRIGHT file distributed with this

 * source distribution.

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA

 */

#ifndef _PURPLE_ACCOUNT_H_

#define _PURPLE_ACCOUNT_H_

#include <glib.h>

#include <glib-object.h>

/** @copydoc _PurpleAccountUiOps */

typedef struct _PurpleAccountUiOps PurpleAccountUiOps;

/** @copydoc _PurpleAccount */

typedef struct _PurpleAccount      PurpleAccount;

typedef gboolean (*PurpleFilterAccountFunc)(PurpleAccount *account);

typedef void (*PurpleAccountRequestAuthorizationCb)(void *);

typedef void (*PurpleAccountRegistrationCb)(PurpleAccount *account, gboolean succeeded, void *user_data);

typedef void (*PurpleAccountUnregistrationCb)(PurpleAccount *account, gboolean succeeded, void *user_data);

#include "connection.h"

#include "log.h"

#include "privacy.h"

#include "proxy.h"

#include "prpl.h"

#include "status.h"

/**

 * Account request types.

 */

typedef enum

{

	PURPLE_ACCOUNT_REQUEST_AUTHORIZATION = 0 /* Account authorization request */

} PurpleAccountRequestType;

/**  Account UI operations, used to notify the user of status changes and when

 *   buddies add this account to their buddy lists.

 */

struct _PurpleAccountUiOps

{

	/** A buddy who is already on this account's buddy list added this account

	 *  to their buddy list.

	 */

	void (*notify_added)(PurpleAccount *account,

	                     const char *remote_user,

	                     const char *id,

	                     const char *alias,

	                     const char *message);

	/** This account's status changed. */

	void (*status_changed)(PurpleAccount *account,

	                       PurpleStatus *status);

	/** Someone we don't have on our list added us; prompt to add them. */

	void (*request_add)(PurpleAccount *account,

	                    const char *remote_user,

	                    const char *id,

	                    const char *alias,

	                    const char *message);

	/** Prompt for authorization when someone adds this account to their buddy

	 * list.  To authorize them to see this account's presence, call \a

	 * authorize_cb (\a user_data); otherwise call \a deny_cb (\a user_data);

	 * @return a UI-specific handle, as passed to #close_account_request.

	 */

	void *(*request_authorize)(PurpleAccount *account,

	                           const char *remote_user,

	                           const char *id,

	                           const char *alias,

	                           const char *message,

	                           gboolean on_list,

	                           PurpleAccountRequestAuthorizationCb authorize_cb,

	                           PurpleAccountRequestAuthorizationCb deny_cb,

	                           void *user_data);

	/** Close a pending request for authorization.  \a ui_handle is a handle

	 *  as returned by #request_authorize.

	 */

	void (*close_account_request)(void *ui_handle);

	void (*_purple_reserved1)(void);

	void (*_purple_reserved2)(void);

	void (*_purple_reserved3)(void);

	void (*_purple_reserved4)(void);

};

/** Structure representing an account.

 */

struct _PurpleAccount

{

	char *username;             /**< The username.                          */

	char *alias;                /**< How you appear to yourself.            */

	char *password;             /**< The account password.                  */

	char *user_info;            /**< User information.                      */

	char *buddy_icon_path;      /**< The buddy icon's non-cached path.      */

	gboolean remember_pass;     /**< Remember the password.                 */

	char *protocol_id;          /**< The ID of the protocol.                */

	PurpleConnection *gc;         /**< The connection handle.                 */

	gboolean disconnecting;     /**< The account is currently disconnecting */

	GHashTable *settings;       /**< Protocol-specific settings.            */

	GHashTable *ui_settings;    /**< UI-specific settings.                  */

	PurpleProxyInfo *proxy_info;  /**< Proxy information.  This will be set   */

								/*   to NULL when the account inherits      */

								/*   proxy settings from global prefs.      */

	/*

	 * TODO: Supplementing the next two linked lists with hash tables

	 * should help performance a lot when these lists are long.  This

	 * matters quite a bit for protocols like MSN, where all your

	 * buddies are added to your permit list.  Currently we have to

	 * iterate through the entire list if we want to check if someone

	 * is permitted or denied.  We should do this for 3.0.0.

	 */

	GSList *permit;             /**< Permit list.                           */

	GSList *deny;               /**< Deny list.                             */

	PurplePrivacyType perm_deny;  /**< The permit/deny setting.               */

	GList *status_types;        /**< Status types.                          */

	PurplePresence *presence;     /**< Presence.                              */

	PurpleLog *system_log;        /**< The system log                         */

	void *ui_data;              /**< The UI can put data here.              */

	PurpleAccountRegistrationCb registration_cb;

	void *registration_cb_user_data;

	gpointer priv;              /**< Pointer to opaque private data. */

};

#ifdef __cplusplus

extern "C" {

#endif

/**************************************************************************/

/** @name Account API                                                     */

/**************************************************************************/

/*@{*/

/**

 * Creates a new account.

 *

 * @param username    The username.

 * @param protocol_id The protocol ID.

 *

 * @return The new account.

 */

PurpleAccount *purple_account_new(const char *username, const char *protocol_id);

/**

 * Destroys an account.

 *

 * @param account The account to destroy.

 */

void purple_account_destroy(PurpleAccount *account);

/**

 * Connects to an account.

 *

 * @param account The account to connect to.

 */

void purple_account_connect(PurpleAccount *account);

/**

 * Sets the callback for successful registration.

 *

 * @param account	The account for which this callback should be used

 * @param cb	The callback

 * @param user_data	The user data passed to the callback

 */

void purple_account_set_register_callback(PurpleAccount *account, PurpleAccountRegistrationCb cb, void *user_data);

/**

 * Registers an account.

 *

 * @param account The account to register.

 */

void purple_account_register(PurpleAccount *account);

/**

 * Unregisters an account (deleting it from the server).

 *

 * @param account The account to unregister.

 * @param cb Optional callback to be called when unregistration is complete

 * @param user_data user data to pass to the callback

 */

void purple_account_unregister(PurpleAccount *account, PurpleAccountUnregistrationCb cb, void *user_data);

/**

 * Disconnects from an account.

 *

 * @param account The account to disconnect from.

 */

void purple_account_disconnect(PurpleAccount *account);

/**

 * Notifies the user that the account was added to a remote user's

 * buddy list.

 *

 * This will present a dialog informing the user that he was added to the

 * remote user's buddy list.

 *

 * @param account     The account that was added.

 * @param remote_user The name of the user that added this account.

 * @param id          The optional ID of the local account. Rarely used.

 * @param alias       The optional alias of the user.

 * @param message     The optional message sent from the user adding you.

 */

void purple_account_notify_added(PurpleAccount *account, const char *remote_user,

                               const char *id, const char *alias,

                               const char *message);

/**

 * Notifies the user that the account was addded to a remote user's buddy

 * list and asks ther user if they want to add the remote user to their buddy

 * list.

 *

 * This will present a dialog informing the local user that the remote user

 * added them to the remote user's buddy list and will ask if they want to add

 * the remote user to the buddy list.

 *

 * @param account     The account that was added.

 * @param remote_user The name of the user that added this account.

 * @param id          The optional ID of the local account. Rarely used.

 * @param alias       The optional alias of the user.

 * @param message     The optional message sent from the user adding you.

 */

void purple_account_request_add(PurpleAccount *account, const char *remote_user,

                              const char *id, const char *alias,

                              const char *message);

/**

 * Notifies the user that a remote user has wants to add the local user

 * to his or her buddy list and requires authorization to do so.

 *

 * This will present a dialog informing the user of this and ask if the

 * user authorizes or denies the remote user from adding him.

 *

 * @param account      The account that was added

 * @param remote_user  The name of the user that added this account.

 * @param id           The optional ID of the local account. Rarely used.

 * @param alias        The optional alias of the remote user.

 * @param message      The optional message sent by the user wanting to add you.

 * @param on_list      Is the remote user already on the buddy list?

 * @param auth_cb      The callback called when the local user accepts

 * @param deny_cb      The callback called when the local user rejects

 * @param user_data    Data to be passed back to the above callbacks

 *

 * @return A UI-specific handle.

 */

void *purple_account_request_authorization(PurpleAccount *account, const char *remote_user,

					const char *id, const char *alias, const char *message, gboolean on_list,

					PurpleAccountRequestAuthorizationCb auth_cb, PurpleAccountRequestAuthorizationCb deny_cb, void *user_data);

/**

 * Close account requests registered for the given PurpleAccount

 *

 * @param account	   The account for which requests should be closed

 */

void purple_account_request_close_with_account(PurpleAccount *account);

/**

 * Close the account request for the given ui handle

 *

 * @param ui_handle	   The ui specific handle for which requests should be closed

 */

void purple_account_request_close(void *ui_handle);

/**

 * Requests a password from the user for the account. Does not set the

 * account password on success; do that in ok_cb if desired.

 *

 * @param account     The account to request the password for.

 * @param ok_cb       The callback for the OK button.

 * @param cancel_cb   The callback for the cancel button.

 * @param user_data   User data to be passed into callbacks.

 */

void purple_account_request_password(PurpleAccount *account, GCallback ok_cb,

				     GCallback cancel_cb, void *user_data);

/**

 * Requests information from the user to change the account's password.

 *

 * @param account The account to change the password on.

 */

void purple_account_request_change_password(PurpleAccount *account);

/**

 * Requests information from the user to change the account's

 * user information.

 *

 * @param account The account to change the user information on.

 */

void purple_account_request_change_user_info(PurpleAccount *account);

/**

 * Sets the account's username.

 *

 * @param account  The account.

 * @param username The username.

 */

void purple_account_set_username(PurpleAccount *account, const char *username);

/**

 * Sets the account's password.

 *

 * @param account  The account.

 * @param password The password.

 */

void purple_account_set_password(PurpleAccount *account, const char *password);

/**

 * Sets the account's alias.

 *

 * @param account The account.

 * @param alias   The alias.

 */

void purple_account_set_alias(PurpleAccount *account, const char *alias);

/**

 * Sets the account's user information

 *

 * @param account   The account.

 * @param user_info The user information.

 */

void purple_account_set_user_info(PurpleAccount *account, const char *user_info);

/**

 * Sets the account's buddy icon path.

 *

 * @param account The account.

 * @param path	  The buddy icon non-cached path.

 */

void purple_account_set_buddy_icon_path(PurpleAccount *account, const char *path);

/**

 * Sets the account's protocol ID.

 *

 * @param account     The account.

 * @param protocol_id The protocol ID.

 */

void purple_account_set_protocol_id(PurpleAccount *account,

								  const char *protocol_id);

/**

 * Sets the account's connection.

 *

 * @param account The account.

 * @param gc      The connection.

 */

void purple_account_set_connection(PurpleAccount *account, PurpleConnection *gc);

/**

 * Sets whether or not this account should save its password.

 *

 * @param account The account.

 * @param value   @c TRUE if it should remember the password.

 */

void purple_account_set_remember_password(PurpleAccount *account, gboolean value);

/**

 * Sets whether or not this account should check for mail.

 *

 * @param account The account.

 * @param value   @c TRUE if it should check for mail.

 */

void purple_account_set_check_mail(PurpleAccount *account, gboolean value);

/**

 * Sets whether or not this account is enabled for the specified

 * UI.

 *

 * @param account The account.

 * @param ui      The UI.

 * @param value   @c TRUE if it is enabled.

 */

void purple_account_set_enabled(PurpleAccount *account, const char *ui,

			      gboolean value);

/**

 * Sets the account's proxy information.

 *

 * @param account The account.

 * @param info    The proxy information.

 */

void purple_account_set_proxy_info(PurpleAccount *account, PurpleProxyInfo *info);

/**

 * Sets the account's status types.

 *

 * @param account      The account.

 * @param status_types The list of status types.

 */

void purple_account_set_status_types(PurpleAccount *account, GList *status_types);

/**

 * Variadic version of purple_account_set_status_list(); the variadic list

 * replaces @a attrs, and should be <tt>NULL</tt>-terminated.

 *

 * @copydoc purple_account_set_status_list()

 */

void purple_account_set_status(PurpleAccount *account, const char *status_id,

	gboolean active, ...) G_GNUC_NULL_TERMINATED;

/**

 * Activates or deactivates a status.  All changes to the statuses of

 * an account go through this function or purple_account_set_status().

 *

 * You can only deactivate an exclusive status by activating another exclusive

 * status.  So, if @a status_id is an exclusive status and @a active is @c

 * FALSE, this function does nothing.

 *

 * @param account   The account.

 * @param status_id The ID of the status.

 * @param active    Whether @a status_id is to be activated (<tt>TRUE</tt>) or

 *                  deactivated (<tt>FALSE</tt>).

 * @param attrs     A list of <tt>const char *</tt> attribute names followed by

 *                  <tt>const char *</tt> attribute values for the status.

 *                  (For example, one pair might be <tt>"message"</tt> followed

 *                  by <tt>"hello, talk to me!"</tt>.)

 */

void purple_account_set_status_list(PurpleAccount *account,

	const char *status_id, gboolean active, GList *attrs);

/**

 * Clears all protocol-specific settings on an account.

 *

 * @param account The account.

 */

void purple_account_clear_settings(PurpleAccount *account);

/**

 * Removes an account-specific setting by name.

 *

 * @param account The account.

 * @param setting The setting to remove.

 *

 * @since 2.6.0

 */

void purple_account_remove_setting(PurpleAccount *account, const char *setting);

/**

 * Sets a protocol-specific integer setting for an account.

 *

 * @param account The account.

 * @param name    The name of the setting.

 * @param value   The setting's value.

 */

void purple_account_set_int(PurpleAccount *account, const char *name, int value);

/**

 * Sets a protocol-specific string setting for an account.

 *

 * @param account The account.

 * @param name    The name of the setting.

 * @param value   The setting's value.

 */

void purple_account_set_string(PurpleAccount *account, const char *name,

							 const char *value);

/**

 * Sets a protocol-specific boolean setting for an account.

 *

 * @param account The account.

 * @param name    The name of the setting.

 * @param value   The setting's value.

 */

void purple_account_set_bool(PurpleAccount *account, const char *name,

						   gboolean value);

/**

 * Sets a UI-specific integer setting for an account.

 *

 * @param account The account.

 * @param ui      The UI name.

 * @param name    The name of the setting.

 * @param value   The setting's value.

 */

void purple_account_set_ui_int(PurpleAccount *account, const char *ui,

							 const char *name, int value);

/**

 * Sets a UI-specific string setting for an account.

 *

 * @param account The account.

 * @param ui      The UI name.

 * @param name    The name of the setting.

 * @param value   The setting's value.

 */

void purple_account_set_ui_string(PurpleAccount *account, const char *ui,

								const char *name, const char *value);

/**

 * Sets a UI-specific boolean setting for an account.

 *

 * @param account The account.

 * @param ui      The UI name.

 * @param name    The name of the setting.

 * @param value   The setting's value.

 */

void purple_account_set_ui_bool(PurpleAccount *account, const char *ui,

							  const char *name, gboolean value);

/**

 * Returns whether or not the account is connected.

 *

 * @param account The account.

 *

 * @return @c TRUE if connected, or @c FALSE otherwise.

 */

gboolean purple_account_is_connected(const PurpleAccount *account);

/**

 * Returns whether or not the account is connecting.

 *

 * @param account The account.

 *

 * @return @c TRUE if connecting, or @c FALSE otherwise.

 */

gboolean purple_account_is_connecting(const PurpleAccount *account);

/**

 * Returns whether or not the account is disconnected.

 *

 * @param account The account.

 *

 * @return @c TRUE if disconnected, or @c FALSE otherwise.

 */

gboolean purple_account_is_disconnected(const PurpleAccount *account);

/**

 * Returns the account's username.

 *

 * @param account The account.

 *

 * @return The username.

 */

const char *purple_account_get_username(const PurpleAccount *account);

/**

 * Returns the account's password.

 *

 * @param account The account.

 *

 * @return The password.

 */

const char *purple_account_get_password(const PurpleAccount *account);

/**

 * Returns the account's alias.

 *

 * @param account The account.

 *

 * @return The alias.

 */

const char *purple_account_get_alias(const PurpleAccount *account);

/**

 * Returns the account's user information.

 *

 * @param account The account.

 *

 * @return The user information.

 */

const char *purple_account_get_user_info(const PurpleAccount *account);

/**

 * Gets the account's buddy icon path.

 *

 * @param account The account.

 *

 * @return The buddy icon's non-cached path.

 */

const char *purple_account_get_buddy_icon_path(const PurpleAccount *account);

/**

 * Returns the account's protocol ID.

 *

 * @param account The account.

 *

 * @return The protocol ID.

 */

const char *purple_account_get_protocol_id(const PurpleAccount *account);

/**

 * Returns the account's protocol name.

 *

 * @param account The account.

 *

 * @return The protocol name.

 */

const char *purple_account_get_protocol_name(const PurpleAccount *account);

/**

 * Returns the account's connection.

 *

 * @param account The account.

 *

 * @return The connection.

 */

PurpleConnection *purple_account_get_connection(const PurpleAccount *account);

/**

 * Returns whether or not this account should save its password.

 *

 * @param account The account.

 *

 * @return @c TRUE if it should remember the password.

 */

gboolean purple_account_get_remember_password(const PurpleAccount *account);

/**

 * Returns whether or not this account should check for mail.

 *

 * @param account The account.

 *

 * @return @c TRUE if it should check for mail.

 */

gboolean purple_account_get_check_mail(const PurpleAccount *account);

/**

 * Returns whether or not this account is enabled for the

 * specified UI.

 *

 * @param account The account.

 * @param ui      The UI.

 *

 * @return @c TRUE if it enabled on this UI.

 */

gboolean purple_account_get_enabled(const PurpleAccount *account,

				  const char *ui);

/**

 * Returns the account's proxy information.

 *

 * @param account The account.

 *

 * @return The proxy information.

 */

PurpleProxyInfo *purple_account_get_proxy_info(const PurpleAccount *account);

/**

 * Returns the active status for this account.  This looks through

 * the PurplePresence associated with this account and returns the

 * PurpleStatus that has its active flag set to "TRUE."  There can be

 * only one active PurpleStatus in a PurplePresence.

 *

 * @param account   The account.

 *

 * @return The active status.

 */

PurpleStatus *purple_account_get_active_status(const PurpleAccount *account);

/**

 * Returns the account status with the specified ID.

 *

 * Note that this works differently than purple_buddy_get_status() in that

 * it will only return NULL if the status was not registered.

 *

 * @param account   The account.

 * @param status_id The status ID.

 *

 * @return The status, or NULL if it was never registered.

 */

PurpleStatus *purple_account_get_status(const PurpleAccount *account,

									const char *status_id);

/**

 * Returns the account status type with the specified ID.

 *

 * @param account The account.

 * @param id      The ID of the status type to find.

 *

 * @return The status type if found, or NULL.

 */

PurpleStatusType *purple_account_get_status_type(const PurpleAccount *account,

											 const char *id);

/**

 * Returns the account status type with the specified primitive.

 * Note: It is possible for an account to have more than one

 * PurpleStatusType with the same primitive.  In this case, the

 * first PurpleStatusType is returned.

 *

 * @param account   The account.

 * @param primitive The type of the status type to find.

 *

 * @return The status if found, or NULL.

 */

PurpleStatusType *purple_account_get_status_type_with_primitive(

							const PurpleAccount *account,

							PurpleStatusPrimitive primitive);

/**

 * Returns the account's presence.

 *

 * @param account The account.

 *

 * @return The account's presence.

 */

PurplePresence *purple_account_get_presence(const PurpleAccount *account);

/**

 * Returns whether or not an account status is active.

 *

 * @param account   The account.

 * @param status_id The status ID.

 *

 * @return TRUE if active, or FALSE if not.

 */

gboolean purple_account_is_status_active(const PurpleAccount *account,

									   const char *status_id);

/**

 * Returns the account's status types.

 *

 * @param account The account.

 *

 * @constreturn The account's status types.

 */

GList *purple_account_get_status_types(const PurpleAccount *account);

/**

 * Returns a protocol-specific integer setting for an account.

 *

 * @param account       The account.

 * @param name          The name of the setting.

 * @param default_value The default value.

 *

 * @return The value.

 */

int purple_account_get_int(const PurpleAccount *account, const char *name,

						 int default_value);

/**

 * Returns a protocol-specific string setting for an account.

 *

 * @param account       The account.

 * @param name          The name of the setting.

 * @param default_value The default value.

 *

 * @return The value.

 */

const char *purple_account_get_string(const PurpleAccount *account,

									const char *name,

									const char *default_value);

/**

 * Returns a protocol-specific boolean setting for an account.

 *

 * @param account       The account.

 * @param name          The name of the setting.

 * @param default_value The default value.

 *

 * @return The value.

 */

gboolean purple_account_get_bool(const PurpleAccount *account, const char *name,