Mercurial > pidgin
view src/protocols/msn/session.h @ 12116:e75ef7aa913e
[gaim-migrate @ 14416]
" This patch implements a replacement for the queuing
system from 1.x. It also obsoletes a previous patch
[#1338873] I submitted to prioritize the unseen states
in gtk conversations.
The attached envelope.png is ripped from the
msgunread.png already included in gaim. It should be
dropped in the pixmaps directory (Makefile.am is
updated accordingly in this patch).
The two separate queuing preferences from 1.x, queuing
messages while away and queuing all new messages (from
docklet), are replaced with a single 3-way preference
for conversations. The new preference is "Hide new IM
conversations". This preference can be set to never,
away and always.
When a gtk conversation is created, it may be placed in
a hidden conversation window instead of being placed
normally. This decision is based upon the preference
and possibly the away state of the account the
conversation is being created for. This *will* effect
conversations the user explicitly requests to be
created, so in these cases the caller must be sure to
present the conversation to the user, using
gaim_gtkconv_present_conversation(). This is done
already in gtkdialogs.c which handles creating
conversations requested by the user from gaim proper
(menus, double-clicking on budy in blist, etc.).
The main advantage to not queuing messages is that the
conversations exist, the message is written to the
conversation (and logged if appropriate) and the unseen
state is set on the conversation. This means no
additional features are needed to track whether there
are queued messages or not, just use the unseen state
on conversations.
Since conversations may not be visible (messages
"queued"), gaim proper needs some notification that
there are messages waiting. I opted for a menutray icon
that shows up when an im conversation has an unseen
message. Clicking this icon will focus (and show if
hidden) the first conversation with an unseen message.
This is essentially the same behavior of the docklet in
cvs right now, except that the icon is only visible
when there is a conversation with an unread message.
The api that is added is flexible enough to allow
either the docklet or the new blist menutray icon to be
visible for conversations of any/all types and for
unseen messages >= any state. Currently they are set to
only IM conversations and only unseen states >= TEXT
(system messages and no log messages will not trigger
blinking the docklet or showing the blist tray icon),
but these could be made preferences relatively easily
in the future. Other plugins could probably benefit as
well: gaim_gtk_conversations_get_first_unseen().
There is probably some limit to comment size, so I'll
stop rambling now. If anyone has more
questions/comments, catch me in #gaim, here or on
gaim-devel."
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Wed, 16 Nov 2005 18:17:01 +0000 |
parents | c824e39db0e7 |
children | 442b23efba54 |
line wrap: on
line source
/** * @file session.h MSN session functions * * gaim * * Gaim 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _MSN_SESSION_H_ #define _MSN_SESSION_H_ typedef struct _MsnSession MsnSession; #include "sslconn.h" #include "notification.h" #include "switchboard.h" #include "user.h" #include "group.h" #include "cmdproc.h" #include "nexus.h" #include "httpconn.h" #include "userlist.h" #include "sync.h" /** * Types of errors. */ typedef enum { MSN_ERROR_SERVCONN, MSN_ERROR_UNSUPPORTED_PROTOCOL, MSN_ERROR_HTTP_MALFORMED, MSN_ERROR_AUTH, MSN_ERROR_BAD_BLIST, MSN_ERROR_SIGN_OTHER, MSN_ERROR_SERV_DOWN, MSN_ERROR_SERV_UNAVAILABLE } MsnErrorType; /** * Login steps. */ typedef enum { MSN_LOGIN_STEP_START, MSN_LOGIN_STEP_HANDSHAKE, MSN_LOGIN_STEP_TRANSFER, MSN_LOGIN_STEP_HANDSHAKE2, MSN_LOGIN_STEP_AUTH_START, MSN_LOGIN_STEP_AUTH, MSN_LOGIN_STEP_GET_COOKIE, MSN_LOGIN_STEP_AUTH_END, MSN_LOGIN_STEP_SYN, MSN_LOGIN_STEP_END } MsnLoginStep; #define MSN_LOGIN_STEPS MSN_LOGIN_STEP_END struct _MsnSession { GaimAccount *account; MsnUser *user; guint protocol_ver; MsnLoginStep login_step; /**< The current step in the login process. */ gboolean connected; gboolean logged_in; /**< A temporal flag to ignore local buddy list adds. */ gboolean destroying; /**< A flag that states if the session is being destroyed. */ gboolean http_method; MsnNotification *notification; MsnNexus *nexus; MsnSync *sync; MsnUserList *userlist; int servconns_count; /**< The count of server connections. */ GList *switches; /**< The list of all the switchboards. */ GList *directconns; /**< The list of all the directconnections. */ GList *slplinks; /**< The list of all the slplinks. */ int conv_seq; /**< The current conversation sequence number. */ struct { char *kv; char *sid; char *mspauth; unsigned long sl; char *file; char *client_ip; int client_port; } passport_info; }; /** * Creates an MSN session. * * @param account The account. * * @return The new MSN session. */ MsnSession *msn_session_new(GaimAccount *account); /** * Destroys an MSN session. * * @param session The MSN session to destroy. */ void msn_session_destroy(MsnSession *session); /** * Connects to and initiates an MSN session. * * @param session The MSN session. * @param host The dispatch server host. * @param port The dispatch server port. * @param http_method Whether to use or not http_method. * * @return @c TRUE on success, @c FALSE on failure. */ gboolean msn_session_connect(MsnSession *session, const char *host, int port, gboolean http_method); /** * Disconnects from an MSN session. * * @param session The MSN session. */ void msn_session_disconnect(MsnSession *session); /** * Finds a switchboard with the given username. * * @param session The MSN session. * @param username The username to search for. * * @return The switchboard, if found. */ MsnSwitchBoard *msn_session_find_swboard(MsnSession *session, const char *username); /** * Finds a switchboard with the given conversation. * * @param session The MSN session. * @param conv The conversation to search for. * * @return The switchboard, if found. */ MsnSwitchBoard *msn_session_find_swboard_with_conv(MsnSession *session, GaimConversation *conv); /** * Finds a switchboard with the given chat ID. * * @param session The MSN session. * @param chat_id The chat ID to search for. * * @return The switchboard, if found. */ MsnSwitchBoard *msn_session_find_swboard_with_id(const MsnSession *session, int chat_id); /** * Returns a switchboard to communicate with certain username. * * @param session The MSN session. * @param username The username to search for. * @param flag The flag of the switchboard * * @return The switchboard. */ MsnSwitchBoard *msn_session_get_swboard(MsnSession *session, const char *username, MsnSBFlag flag); /** * Sets an error for the MSN session. * * @param session The MSN session. * @param error The error. * @param info Extra information. */ void msn_session_set_error(MsnSession *session, MsnErrorType error, const char *info); /** * Sets the current step in the login proccess. * * @param session The MSN session. * @param step The current step. */ void msn_session_set_login_step(MsnSession *session, MsnLoginStep step); /** * Finish the login proccess. * * @param session The MSN session. */ void msn_session_finish_login(MsnSession *session); #endif /* _MSN_SESSION_H_ */