view src/protocols/novell/nmrequest.c @ 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 <[e-mail]>

/*
 * nmrequest.c
 *
 * Copyright (c) 2004 Novell, Inc. All Rights Reserved.
 *
 * 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; version 2 of the License.
 *
 * 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
 *
 */

#include "nmrequest.h"

static int count = 0;

struct _NMRequest
{
	int trans_id;
	char *cmd;
	int gmt;
	gpointer data;
	gpointer user_define;
	nm_response_cb callback;
	int ref_count;
	NMERR_T ret_code;
};

NMRequest *nm_create_request(const char *cmd, int trans_id, int gmt, nm_response_cb cb,
							 gpointer resp_data, gpointer user_define)
{
	NMRequest *req;

	if (cmd == NULL)
		return NULL;

	req  = g_new0(NMRequest, 1);
	req->cmd = g_strdup(cmd);
	req->trans_id = trans_id;
	req->gmt = gmt;
	req->callback = cb;
	req->data = resp_data;
	req->user_define = user_define;
	req->ref_count = 1;

	gaim_debug_info("novell", "Creating NMRequest instance, total=%d\n", ++count);

	return req;
}

void
nm_release_request(NMRequest * req)
{
	if (req && (--req->ref_count == 0)) {
		if (req->cmd)
			g_free(req->cmd);
		g_free(req);

		gaim_debug_info("novell",
						"Releasing NMRequest instance, total=%d\n", --count);
	}

}

void
nm_request_add_ref(NMRequest * req)
{
	if (req)
		req->ref_count++;
}

void
nm_request_set_callback(NMRequest * req, nm_response_cb callback)
{
	if (req)
		req->callback = callback;
}

void
nm_request_set_data(NMRequest * req, gpointer data)
{
	if (req)
		req->data = data;
}

void
nm_request_set_user_define(NMRequest * req, gpointer user_define)
{
	if (req)
		req->user_define = user_define;
}

int
nm_request_get_trans_id(NMRequest * req)
{
	if (req)
		return req->trans_id;
	else
		return -1;
}

const char *
nm_request_get_cmd(NMRequest * req)
{
	if (req == NULL)
		return NULL;

	return req->cmd;
}

gpointer
nm_request_get_data(NMRequest * req)
{
	if (req == NULL)
		return NULL;

	return req->data;
}

gpointer
nm_request_get_user_define(NMRequest * req)
{
	if (req == NULL)
		return NULL;

	return req->user_define;
}

nm_response_cb
nm_request_get_callback(NMRequest * req)
{
	if (req == NULL)
		return NULL;

	return req->callback;
}


void
nm_request_set_ret_code(NMRequest * req, NMERR_T rc)
{
	if (req)
		req->ret_code = rc;
}

NMERR_T
nm_request_get_ret_code(NMRequest * req)
{
	if (req)
		return req->ret_code;
	else
		return (NMERR_T) - 1;
}