switchboard.h

/**
 * Copyright (C) 2008-2009 Felipe Contreras
 * Copyright (C) 1998-2006 Pidgin (see pidgin-copyright)
 *
 * 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  02110-1301, USA.
 */

#ifndef MSN_SWITCHBOARD_H
#define MSN_SWITCHBOARD_H

#include <glib.h>

typedef struct MsnSwitchBoard MsnSwitchBoard;

/**
 * A switchboard error.
 */
typedef enum
{
    MSN_SB_ERROR_NONE, /**< No error. */
    MSN_SB_ERROR_CAL, /**< The user could not join (answer the call). */
    MSN_SB_ERROR_OFFLINE, /**< The account is offline. */
    MSN_SB_ERROR_USER_OFFLINE, /**< The user to call is offline. */
    MSN_SB_ERROR_CONNECTION, /**< There was a connection error. */
    MSN_SB_ERROR_TOO_FAST, /**< We are sending too fast */
    MSN_SB_ERROR_AUTHFAILED, /**< Authentication failed joining the switchboard session */
    MSN_SB_ERROR_UNKNOWN /**< An unknown error occurred. */

} MsnSBErrorType;

#include "io/pn_cmd_server.h"
#include "io/pn_node.h"
#include "pn_timer.h"

struct MsnSession;
struct MsnMessage;
struct MsnCmdProc;

struct _PurpleConversation;

/**
 * A switchboard.
 *
 * A place where a bunch of users send messages to the rest of the users.
 */
struct MsnSwitchBoard
{
    struct MsnSession *session;
    struct MsnCmdProc *cmdproc;
    char *im_user;

    char *auth_key;
    char *session_id;

    struct _PurpleConversation *conv; /**< The conversation that displays the
                                messages of this switchboard, or @c NULL if
                                this is a helper switchboard. */

    gboolean empty;			/**< A flag that states if the swithcboard has no
                                          users in it. */
    gboolean invited;		/**< A flag that states if we were invited to the
                                  switchboard. */
    gboolean ready;			/**< A flag that states if this switchboard is
                                          ready to be used. */
    gboolean closed; /**< The switchboard has been closed. */

    int current_users;
    int total_users;
    GList *users;

    int chat_id;

    GQueue *msg_queue; /**< Queue of messages to send. */
    GQueue *invites; /**< Queue of participants to invite. */
    GList *ack_list; /**< List of messages waiting for an ack. */

    MsnSBErrorType error; /**< The error that occurred in this switchboard
                            (if applicable). */
    GList *calls; /**< The list of peer calls that are using this switchboard. */

    PnCmdServer *conn;
    gulong open_handler;
    gulong close_handler;
    gulong error_handler;

    guint ref_count;
    struct pn_timer *timer;
};

/**
 * Initialize the variables for switchboard creation.
 */
void msn_switchboard_init(void);

/**
 * Destroy the variables for switchboard creation.
 */
void msn_switchboard_end(void);

/**
 * Creates a new switchboard.
 *
 * @param session The MSN session.
 *
 * @return The new switchboard.
 */
MsnSwitchBoard *msn_switchboard_new(struct MsnSession *session);

/**
 * Destroys a switchboard.
 *
 * @param swboard The switchboard to destroy.
 */
void msn_switchboard_destroy(MsnSwitchBoard *swboard);

MsnSwitchBoard *msn_switchboard_ref (MsnSwitchBoard *swboard);
MsnSwitchBoard *msn_switchboard_unref (MsnSwitchBoard *swboard);

/**
 * Sets the auth key the switchboard must use when connecting.
 *
 * @param swboard The switchboard.
 * @param key     The auth key.
 */
void msn_switchboard_set_auth_key(MsnSwitchBoard *swboard, const char *key);

/**
 * Returns the auth key the switchboard must use when connecting.
 *
 * @param swboard The switchboard.
 *
 * @return The auth key.
 */
const char *msn_switchboard_get_auth_key(MsnSwitchBoard *swboard);

/**
 * Sets the session ID the switchboard must use when connecting.
 *
 * @param swboard The switchboard.
 * @param id      The session ID.
 */
void msn_switchboard_set_session_id(MsnSwitchBoard *swboard, const char *id);

/**
 * Returns the session ID the switchboard must use when connecting.
 *
 * @param swboard The switchboard.
 *
 * @return The session ID.
 */
const char *msn_switchboard_get_session_id(MsnSwitchBoard *swboard);

/**
 * Sets whether or not we were invited to this switchboard.
 *
 * @param swboard The switchboard.
 * @param invite  @c TRUE if invited, @c FALSE otherwise.
 */
void msn_switchboard_set_invited(MsnSwitchBoard *swboard, gboolean invited);

/**
 * Returns whether or not we were invited to this switchboard.
 *
 * @param swboard The switchboard.
 *
 * @return @c TRUE if invited, @c FALSE otherwise.
 */
gboolean msn_switchboard_is_invited(MsnSwitchBoard *swboard);

/**
 * Connects to a switchboard.
 *
 * @param swboard The switchboard.
 * @param host    The switchboard server host.
 * @param port    The switcbharod server port.
 *
 * @return @c TRUE if able to connect, or @c FALSE otherwise.
 */
gboolean msn_switchboard_connect(MsnSwitchBoard *swboard,
                                 const char *host, int port);

/**
 * Disconnects from a switchboard.
 *
 * @param swboard The switchboard to disconnect from.
 */
void msn_switchboard_disconnect(MsnSwitchBoard *swboard);

/**
 * Closes the switchboard.
 *
 * Called when a conversation is closed.
 *
 * @param swboard The switchboard to close.
 */
void msn_switchboard_close(MsnSwitchBoard *swboard);

/**
 * Returns whether or not we currently can send a message through this
 * switchboard.
 *
 * @param swboard The switchboard.
 *
 * @return @c TRUE if a message can be sent, @c FALSE otherwise.
 */
gboolean msn_switchboard_can_send(MsnSwitchBoard *swboard);

/**
 * Sends a message through this switchboard.
 *
 * @param swboard The switchboard.
 * @param msg The message.
 * @param queue A flag that states if we want this message to be queued (in
 * the case it cannot currently be sent).
 *
 * @return @c TRUE if a message can be sent, @c FALSE otherwise.
 */
void msn_switchboard_send_msg(MsnSwitchBoard *swboard, struct MsnMessage *msg,
                              gboolean queue);

gboolean msn_switchboard_chat_leave(MsnSwitchBoard *swboard);
gboolean msn_switchboard_chat_invite(MsnSwitchBoard *swboard, const char *who);

void msn_switchboard_request(MsnSwitchBoard *swboard);
void msn_switchboard_request_add_user(MsnSwitchBoard *swboard, const char *user);

/**
 * Shows an ink message from this switchboard.
 *
 * @param swboard  The switchboard.
 * @param passport The user that sent the ink.
 * @param data     The ink data.
 */
void switchboard_show_ink (MsnSwitchBoard *swboard, const char *passport, const char *data);

#endif /* MSN_SWITCHBOARD_H */