annotate plugins/perl/scripts/conversation.pl @ 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]>

$MODULE_NAME = "Conversation Test";

use Gaim;

# All the information Gaim gets about our nifty plugin
%PLUGIN_INFO = ( 
	perl_api_version => 2, 
	name => " Perl: $MODULE_NAME", 
	version => "0.1", 
	summary => "Test plugin for the Perl interpreter.", 
	description => "Implements a set of test proccedures to ensure all functions that work in the C API still work in the Perl plugin interface.  As XSUBs are added, this *should* be updated to test the changes.  Furthermore, this will function as the tutorial perl plugin.", 
	author => "John H. Kelm <johnhkelm\@gmail.com>", 
	url => "http://sourceforge.net/users/johnhkelm/", 
	
	load => "plugin_load", 
	unload => "plugin_unload" 
); 


	# These names must already exist
	my $GROUP		= "UIUC Buddies";
	my $USERNAME 		= "johnhkelm2";
	
	# We will create these on load then destroy them on unload
	my $TEST_GROUP		= "UConn Buddies";
	my $TEST_NAME	 	= "johnhkelm";
	my $TEST_ALIAS	 	= "John Kelm";
	my $PROTOCOL_ID 	= "prpl-oscar";


sub plugin_init { 
	return %PLUGIN_INFO; 
} 


# This is the sub defined in %PLUGIN_INFO to be called when the plugin is loaded
#	Note: The plugin has a reference to itself on top of the argument stack.
sub plugin_load { 
	my $plugin = shift; 
	print "#" x 80 . "\n\n";

	print "PERL: Finding account.\n";
	$account = Gaim::Accounts::find($USERNAME, $PROTOCOL_ID);
	
	#########  TEST CODE HERE  ##########
	print "Testing Gaim::Conv::new()...";
	$conv1 = Gaim::Conv::new(1, $account, "Test Conv. 1");
	if ($conv) { print "ok.\n"; } else { print "fail.\n"; }

	print "Testing Gaim::Conv::new()...";
	$conv2 = Gaim::Conv::new(1, $account, "Test Conv. 2");
	if ($conv) { print "ok.\n"; } else { print "fail.\n"; }
	
	print "Testing Gaim::Conv::Window::new()...\n";
	$win = Gaim::Conv::Window::new();	
	
	print "Testing Gaim::Conv::Window::add_conversation()...";
	$conv_count = Gaim::Conv::Window::add_conversation($win, $conv1);
	if ($conv_count) { print "ok..." . $conv_count . " conversations...\n"; } else { print "fail.\n"; }

	print "Testing Gaim::Conv::Window::add_conversation()...";
	$conv_count = Gaim::Conv::Window::add_conversation($win, $conv2);
	if ($conv_count) { print "ok..." . $conv_count . " conversations...\n"; } else { print "fail.\n"; }
	
	print "Testing Gaim::Conv::Window::show()...\n";
	Gaim::Conv::Window::show($win);
	
	print "Testing Gaim::Conv::get_im_data()...\n";
	$im = Gaim::Conv::get_im_data($conv1);	
	if ($im) { print "ok.\n"; } else { print "fail.\n"; }
	
	print "Testing Gaim::Conv::IM::send()...\n";
	Gaim::Conv::IM::send($im, "Message Test.");
	
	print "Testing Gaim::Conv::IM::write()...\n";
	Gaim::Conv::IM::write($im, "sendingUser", "<b>Message</b> Test.", 0, 0);
	
	print "#" x 80 . "\n\n";
} 

sub plugin_unload { 
	my $plugin = shift; 

	print "#" x 80 . "\n\n";
	#########  TEST CODE HERE  ##########


	
	print "Testing Gaim::Conv::Window::get_conversation_count()...\n";
	$conv_count = Gaim::Conv::Window::get_conversation_count($win);
	print $conv_count;
	if ($conv_count > 0) {
		print "Testing Gaim::Conv::Window::destroy()...\n";
		Gaim::Conv::Window::destroy($win);
	}
	
	print "\n\n" . "#" x 80 . "\n\n";
}