File Coverage

blib/lib/Net/GrowlClient.pm

Criterion	Covered	Total	%
statement	90	147	61.2
branch	2	18	11.1
condition	3	25	12.0
subroutine	29	34	85.2
pod	2	2	100.0
total	126	226	55.7

package Net::GrowlClient;

use 5.006000;
use strict;
use warnings;
use IO::Socket;
use Digest::MD5 qw( md5_hex );
use Digest::SHA qw( sha256_hex );
use utf8;
use Carp;
require Exporter;
our @ISA = ("Exporter");
our @EXPORT = qw(notify $VERSION @ISA);
our $VERSION = '0.02';

##############################################
##    CONSTANTS
##############################################
use constant GROWL_UDP_PORT 					=> '9887';
use constant GROWL_PROTOCOL_VERSION 			=> '1';
use constant GROWL_PROTOCOL_VERSION_AES128 		=> '2';
use constant GROWL_TYPE_REGISTRATION 			=> '0';
use constant GROWL_TYPE_NOTIFICATION 			=> '1';
use constant GROWL_TYPE_REGISTRATION_SHA256 	=> '2';
use constant GROWL_TYPE_NOTIFICATION_SHA256 	=> '3';
use constant GROWL_TYPE_REGISTRATION_NOAUTH 	=> '4';
use constant GROWL_TYPE_NOTIFICATION_NOAUTH 	=> '5';

use constant CLIENT_DEFAULT_APPNAME				=> 'Net::GrowlClient';
use constant CLIENT_DEFAULT_NOTIFICATION_LIST	=> ['Net::GrowlClient Notification'];
use constant CLIENT_DEFAULT_NOTIFICATION		=> CLIENT_DEFAULT_NOTIFICATION_LIST->[0];
use constant CLIENT_DEFAULT_TITLE				=> 'Hello from Net::GrowlClient!';
use constant CLIENT_DEFAULT_MESSAGE				=> "Yeah! It Works!\nThis is the default message.";
use constant CLIENT_DEFAULT_PRIORITY			=> 0;
use constant FALSE								=> 0;
use constant TRUE								=> 1;

##############################################
##    CONSTRUCTOR
##############################################
sub init
{
	my $caller = shift;
	my $class = ref($caller) || $caller;
	my $self = 	{
			'CLIENT_PASSWORD'			=> FALSE,
			'CLIENT_PEER_HOST'			=> FALSE,
			'CLIENT_PEER_PORT'			=> FALSE,
			'CLIENT_STICKY'				=> FALSE,
			'CLIENT_SKIP_REGISTER'		=> FALSE,
			'CLIENT_CRYPT'				=> FALSE,
			'CLIENT_APPLICATION_NAME'	=> CLIENT_DEFAULT_APPNAME,
			'CLIENT_NOTIFICATION_LIST'	=> CLIENT_DEFAULT_NOTIFICATION_LIST,
			'CLIENT_TYPE_REGISTRATION'	=> GROWL_TYPE_REGISTRATION_NOAUTH,
			'CLIENT_TYPE_NOTIFICATION'	=> GROWL_TYPE_NOTIFICATION_NOAUTH,
			'CLIENT_NOTIFICATION'		=> CLIENT_DEFAULT_NOTIFICATION,
			'CLIENT_TITLE'				=> CLIENT_DEFAULT_TITLE,
			'CLIENT_MESSAGE'			=> CLIENT_DEFAULT_MESSAGE,
			'CLIENT_PRIORITY'			=> CLIENT_DEFAULT_PRIORITY,
			@_
			};

	bless($self, $class);
	&_init($self);
	&_register($self) unless $self->{'CLIENT_SKIP_REGISTER'};
	return $self;
}

##############################################
##    INITIALIZE UDP SOCKET
##############################################
sub _init
{
	my $self = shift;
	$self->{'CLIENT_SOCKET'} = IO::Socket::INET->new
										(
										PeerPort	=> $self->{'CLIENT_PEER_PORT'} || GROWL_UDP_PORT,
										PeerHost  	=> $self->{'CLIENT_PEER_HOST'} || 'localhost',
										Proto     	=> 'udp',
										Type		=> SOCK_DGRAM,
										ReuseAddr	=> 1
										) or croak __PACKAGE__." --> $@";
}

##############################################
##    REGISTER
##############################################
sub _register
{
	use bytes;
	my $self = shift;
	my ($data, $ckecksum, $notification_pack, $default_pack, $packet, $checksum);
	my $notification_list_ptr = $self->{'CLIENT_NOTIFICATION_LIST'};
	my $application_name = $self->{'CLIENT_APPLICATION_NAME'};
	my $password = $self->{'CLIENT_PASSWORD'};
	utf8::encode($password);
	utf8::encode($application_name);

	foreach my $notification ( @$notification_list_ptr )
	{
		utf8::encode($notification);
		$notification_pack .= pack 	(
									'na*',
									bytes::length($notification),
									$notification
									);
	}
	foreach my $default_notification (0..scalar @$notification_list_ptr - 1)
	{
		$default_pack .= pack('C', $default_notification);
	}

	$data = pack 	(
					'CCnCC',
					GROWL_PROTOCOL_VERSION,
					$self->{'CLIENT_TYPE_REGISTRATION'},
					bytes::length($application_name),
					(scalar @$notification_list_ptr),
					(scalar @$notification_list_ptr)
					);
	$data .= pack ('a*', $application_name);
	$data .= $notification_pack . $default_pack;

	if ($self->{'CLIENT_TYPE_REGISTRATION'} eq GROWL_TYPE_REGISTRATION)
	{
		$checksum = pack ('H32', md5_hex($data . $password));
		$packet = $data . $checksum;
	}
	elsif ($self->{'CLIENT_TYPE_REGISTRATION'} eq GROWL_TYPE_REGISTRATION_SHA256)
	{
		$checksum = pack ('H64', sha256_hex($data . $password));
		$packet = $data . $checksum;
	}
	else
	{
		$packet = $data;
	}

	&_sender($self, $packet);
}

##############################################
##    NOTIFY
##############################################
sub notify
{
	use bytes;
	my $self = shift;
	my %notify_args = @_;
	my ($notification_name, $title, $message, $application_name, $checksum, $data, $packet, $priority, $flags, $sticky, $password);
	my %priority = 	(
						"-2" 		=> "011",
						"Low" 		=> "011",
						"Very Low"	=> "011",
						"-1" 		=> "111",
						"Moderate"	=> "111",
						"0"			=> "000",
						"Normal"	=> "000",
						"1"			=> "100",
						"High"		=> "100",
						"2"			=> "010",
						"Emergency"	=> "010"
	);

	$password = $self->{'CLIENT_PASSWORD'};utf8::encode($password);
	$application_name = $notify_args{'application'} || $self->{'CLIENT_APPLICATION_NAME'};utf8::encode($application_name);
	$notification_name = $notify_args{'notification'} || $self->{'CLIENT_NOTIFICATION'};utf8::encode($notification_name);
	$title = $notify_args{'title'} || $self->{'CLIENT_TITLE'};utf8::encode($title);
	$message = $notify_args{'message'} || $self->{'CLIENT_MESSAGE'};utf8::encode($message);
	$sticky = $notify_args{'sticky'} || $self->{'CLIENT_STICKY'};

	if (($notify_args{'priority'}) and (grep (/^$notify_args{'priority'}$/, keys %priority)))
	{
		$priority = $priority{$notify_args{'priority'}};
	}
	else
	{
		$priority = $self->{'CLIENT_PRIORITY'};
		carp __PACKAGE__." --> Unknown Priority \'$notify_args{'priority'}\'" if ($notify_args{'priority'});
	}

	$flags = '0'x12 .$priority.$sticky;

	$data = pack (		'CCb[16]nnnna*',
						GROWL_PROTOCOL_VERSION,
						$self->{'CLIENT_TYPE_NOTIFICATION'},
						$flags,
						bytes::length($notification_name),
						bytes::length($title),
						bytes::length($message),
						bytes::length($application_name),
						"$notification_name$title$message$application_name"
						);

	if ($self->{'CLIENT_TYPE_NOTIFICATION'} eq GROWL_TYPE_NOTIFICATION)
	{
		$checksum = pack ('H32', md5_hex($data . $password));
		$packet = $data . $checksum;
	}
	elsif ($self->{'CLIENT_TYPE_NOTIFICATION'} eq GROWL_TYPE_NOTIFICATION_SHA256)
		{
		$checksum = pack ('H64', sha256_hex($data . $password));
		$packet = $data . $checksum;
	}
	else
	{
		$packet = $data;
	}

	&_sender($self, $packet);
}
##############################################
##    DATA CRYPT (AES128)
##############################################
sub _aescrypt
{
	my $self=shift;
	my $packet;
	return $packet;
}
##############################################
##    SOCKET PRINTER
##############################################
sub _sender
{
	my $self = shift;
	my $packet = shift;
	$self->{'CLIENT_SOCKET'}->send($packet) or carp __PACKAGE__." --> $@";
}

##############################################
##    DESTRUCTOR
###############################################
sub DESTROY
{
	#Still thinking about what I could insert here;
}
1;

__END__