Net/XMPP2/Client.pm

package Net::XMPP2::Client;
use strict;
use AnyEvent;
use Net::XMPP2::IM::Connection;
use Net::XMPP2::Util qw/stringprep_jid prep_bare_jid/;
use Net::XMPP2::Namespaces qw/xmpp_ns/;
use Net::XMPP2::Event;
use Net::XMPP2::IM::Account;

use XML::Twig;

sub _dumpxml {
   my $data = shift;
   my $t = XML::Twig->new;
   if ($t->safe_parse ("<deb>$data</deb>")) {
      $t->set_pretty_print ('indented');
      $t->print;
      print "\n";
   } else {
      print "[$data]\n";
   }
}

our @ISA = qw/Net::XMPP2::Event/;

=head1 NAME

Net::XMPP2::Client - A XMPP Client abstraction

=head1 SYNOPSIS

   use Net::XMPP2::Client;
   use AnyEvent;

   my $j = AnyEvent->condvar;

   my $cl = Net::XMPP2::Client->new;
   $cl->start;

   $j->wait;

=head1 DESCRIPTION

This module tries to implement a straight forward and easy to
use API to communicate with XMPP entities. L<Net::XMPP2::Client>
handles connections and timeouts and all such stuff for you.

For more flexibility please have a look at L<Net::XMPP2::Connection>
and L<Net::XMPP2::IM::Connection>, they allow you to control what
and how something is being sent more precisely.

=head1 METHODS

=head2 new (%args)

Following arguments can be passed in C<%args>:

=over 4

=back

=cut

sub new {
   my $this = shift;
   my $class = ref($this) || $this;
   my $self = { @_ };
   bless $self, $class;
   return $self;
}

=head2 add_account ($jid, $password, $host, $port)

This method adds a jabber account for connection with the JID C<$jid>
and the password C<$password>.

C<$host> and C<$port> are optional and can be undef. C<$host> overrides the
host to connect to.

Returns 1 on success and undef when the account already exists.

=cut

sub add_account {
   my ($self, $jid, $password, $host, $port) = @_;

   $jid = stringprep_jid $jid;
   my $bj = prep_bare_jid $jid;

   return if exists $self->{accounts}->{$bj};

   my $acc =
      $self->{accounts}->{$bj} =
         Net::XMPP2::IM::Account->new (
            jid      => $jid,
            password => $password,
            host     => $host,
            port     => $port,
         );

   $self->update_connections
      if $self->{started};

   $acc
}

=head2 start ()

This method initiates the connections to the XMPP servers.

=cut

sub start {
   my ($self) = @_;
   $self->{started} = 1;
   $self->update_connections;
}

sub update_connections {
   my ($self) = @_;

   for my $acc (values %{$self->{accounts}}) {
      unless ($acc->is_connected) {
         my $con = $acc->spawn_connection;

         $con->reg_cb (
            session_ready => sub {
               my ($con) = @_;
               $self->event (connected => $acc);
               warn "ADDED ACCOUNT $acc->{jid} [$con]\n";
               0 # do once
            },
            debug_recv      => sub { print "RRRRRRRRECVVVVVV:\n"; _dumpxml ($_[1]); 1 },
            debug_send      => sub { print "SSSSSSSSENDDDDDD:\n"; _dumpxml ($_[1]); 1 },
            message         => sub {
               my ($con, $msg) = @_;
               $self->event (message => $acc, $msg);
               1
            },
            presence_update => sub {
               my ($con, $roster, $contact, $old, $new) = @_;
               $self->event (presence_update => $acc, $roster, $contact, $old, $new);
               1
            }
         );

         $con->connect
            or die "Couldn't connect to ".($acc->jid).": $!";
         $con->init
      }
   }
}

=item send_message ($msg, $dest_jid, $src)

Sends a message to the destination C<$dest_jid>.
C<$msg> can either be a string or a L<Net::XMPP2::IM::Message> object.
If C<$msg> is such an object C<$dest_jid> is optional, and will, when
passed, override the destination of the message.

C<$src> is optional. It specifies which account to use
to send the message. If it is not passed L<Net::XMPP2::Client> will try
to find an account itself. First it will look through all rosters
to find C<$dest_jid> and if none found it will pick any of the accounts that
are connected.

C<$src> can either be a JID or a L<Net::XMPP2::IM::Account> object as returned
by C<add_account> and C<get_account>.

=cut

sub send_message {
   my ($self, $msg, $dest_jid, $src) = @_;

   unless (ref $msg) {
      $msg = Net::XMPP2::IM::Message->new (body => $msg);
   }

   if (defined $dest_jid) {
      my $jid = stringprep_jid $dest_jid
         or die "send_message: \$dest_jid is not a proper JID";
      $msg->to ($jid);
   }

   my $srcacc;
   if (ref $src) {
      $srcacc = $src;
   } elsif (defined $src) {
      $srcacc = $self->get_account ($src)
   } else {
      $srcacc = $self->find_account_for_dest_jid ($dest_jid);
   }

   unless ($srcacc && $srcacc->is_connected) {
      die "send_message: Couldn't get connected account for sending"
   }

   $msg->send ($srcacc->connection)
}

=item get_account ($jid)

Returns the L<Net::XMPP2::IM::Account> account object for the JID C<$jid>
if there is any such account added. (returns undef otherwise).

=cut

sub get_account {
   my ($self, $jid) = @_;
   $self->{accounts}->{prep_bare_jid $jid}
}

sub find_account_for_dest_jid {
   my ($self, $jid) = @_;

   my $any_acc;
   for my $acc (values %{$self->{accounts}}) {
      next unless $acc->is_connected;

      # take "first" active account
      $any_acc = $acc unless defined $any_acc;

      my $roster = $acc->connection ()->get_roster;
      if (my $c = $roster->get_contact ($jid)) {
         return $acc;
      }
   }

   $any_acc
}

=head1 EVENTS

These events can be registered on with C<reg_cb>:

In the following event descriptions the argument C<$account>
is always a L<Net::XMMP2::IM::Account> object.

=over 4

=item connected => $account

This event is sent when the C<$account> was successfully connected.

=item connect_error => $account

This event is emitted when an error occured in the connection process for the
account C<$account>.

=item error => $account

This event is emitted when any error occured while communicating
over the connection to the C<$account> - after a connection was established.

=item presence_update => $account, $roster, $contact, $old_presence, $new_presence

This event is emitted when a presence update was received on the C<$account>.
For a description of the other argument please look at the documentation
of the C<presence_update> event in L<Net::XMPP2::IM::Connection>.

=item message => $account, $msg

This event is emited when a message has been received on the C<$account>.
C<$msg> is a L<Net::XMPP2::IM::Message> object.

=back

=head1 AUTHOR

Robin Redeker, C<< <elmex at ta-sa.org> >>

=head1 COPYRIGHT & LICENSE

Copyright 2007 Robin Redeker, all rights reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1; # End of Net::XMPP2::Client
Revision:	1.2
Committed:	Fri Apr 20 14:56:45 2007 UTC (19 years, 5 months ago) by elmex
Branch:	MAIN
Changes since 1.1:	+202 -16 lines
Log Message:	implemented Client.pm. Implemented error objects which simplyfied the error reporting.
#	User	Rev	Content
1	elmex	1.1	package Net::XMPP2::Client;
2			use strict;
3			use AnyEvent;
4	elmex	1.2	use Net::XMPP2::IM::Connection;
5			use Net::XMPP2::Util qw/stringprep_jid prep_bare_jid/;
6			use Net::XMPP2::Namespaces qw/xmpp_ns/;
7	elmex	1.1	use Net::XMPP2::Event;
8	elmex	1.2	use Net::XMPP2::IM::Account;
9
10			use XML::Twig;
11
12			sub _dumpxml {
13			my $data = shift;
14			my $t = XML::Twig->new;
15			if ($t->safe_parse ("<deb>$data</deb>")) {
16			$t->set_pretty_print ('indented');
17			$t->print;
18			print "\n";
19			} else {
20			print "[$data]\n";
21			}
22			}
23	elmex	1.1
24			our @ISA = qw/Net::XMPP2::Event/;
25
26			=head1 NAME
27
28			Net::XMPP2::Client - A XMPP Client abstraction
29
30			=head1 SYNOPSIS
31
32			use Net::XMPP2::Client;
33			use AnyEvent;
34
35			my $j = AnyEvent->condvar;
36
37			my $cl = Net::XMPP2::Client->new;
38			$cl->start;
39
40			$j->wait;
41
42			=head1 DESCRIPTION
43
44			This module tries to implement a straight forward and easy to
45			use API to communicate with XMPP entities. L<Net::XMPP2::Client>
46			handles connections and timeouts and all such stuff for you.
47
48			For more flexibility please have a look at L<Net::XMPP2::Connection>
49			and L<Net::XMPP2::IM::Connection>, they allow you to control what
50			and how something is being sent more precisely.
51
52			=head1 METHODS
53
54			=head2 new (%args)
55
56			Following arguments can be passed in C<%args>:
57
58			=over 4
59
60			=back
61
62			=cut
63
64			sub new {
65			my $this = shift;
66			my $class = ref($this) \|\| $this;
67			my $self = { @_ };
68			bless $self, $class;
69	elmex	1.2	return $self;
70			}
71
72			=head2 add_account ($jid, $password, $host, $port)
73
74			This method adds a jabber account for connection with the JID C<$jid>
75			and the password C<$password>.
76
77			C<$host> and C<$port> are optional and can be undef. C<$host> overrides the
78			host to connect to.
79
80			Returns 1 on success and undef when the account already exists.
81
82			=cut
83
84			sub add_account {
85			my ($self, $jid, $password, $host, $port) = @_;
86
87			$jid = stringprep_jid $jid;
88			my $bj = prep_bare_jid $jid;
89
90			return if exists $self->{accounts}->{$bj};
91
92			my $acc =
93			$self->{accounts}->{$bj} =
94			Net::XMPP2::IM::Account->new (
95			jid => $jid,
96			password => $password,
97			host => $host,
98			port => $port,
99			);
100
101			$self->update_connections
102			if $self->{started};
103
104			$acc
105			}
106
107			=head2 start ()
108
109			This method initiates the connections to the XMPP servers.
110
111			=cut
112
113			sub start {
114			my ($self) = @_;
115			$self->{started} = 1;
116			$self->update_connections;
117			}
118
119			sub update_connections {
120			my ($self) = @_;
121	elmex	1.1
122	elmex	1.2	for my $acc (values %{$self->{accounts}}) {
123			unless ($acc->is_connected) {
124			my $con = $acc->spawn_connection;
125
126			$con->reg_cb (
127			session_ready => sub {
128			my ($con) = @_;
129			$self->event (connected => $acc);
130			warn "ADDED ACCOUNT $acc->{jid} [$con]\n";
131			0 # do once
132			},
133			debug_recv => sub { print "RRRRRRRRECVVVVVV:\n"; _dumpxml ($_[1]); 1 },
134			debug_send => sub { print "SSSSSSSSENDDDDDD:\n"; _dumpxml ($_[1]); 1 },
135			message => sub {
136			my ($con, $msg) = @_;
137			$self->event (message => $acc, $msg);
138			1
139			},
140			presence_update => sub {
141			my ($con, $roster, $contact, $old, $new) = @_;
142			$self->event (presence_update => $acc, $roster, $contact, $old, $new);
143			1
144			}
145			);
146
147			$con->connect
148			or die "Couldn't connect to ".($acc->jid).": $!";
149			$con->init
150			}
151			}
152			}
153
154			=item send_message ($msg, $dest_jid, $src)
155
156			Sends a message to the destination C<$dest_jid>.
157			C<$msg> can either be a string or a L<Net::XMPP2::IM::Message> object.
158			If C<$msg> is such an object C<$dest_jid> is optional, and will, when
159			passed, override the destination of the message.
160
161			C<$src> is optional. It specifies which account to use
162			to send the message. If it is not passed L<Net::XMPP2::Client> will try
163			to find an account itself. First it will look through all rosters
164			to find C<$dest_jid> and if none found it will pick any of the accounts that
165			are connected.
166
167			C<$src> can either be a JID or a L<Net::XMPP2::IM::Account> object as returned
168			by C<add_account> and C<get_account>.
169
170			=cut
171
172			sub send_message {
173			my ($self, $msg, $dest_jid, $src) = @_;
174
175			unless (ref $msg) {
176			$msg = Net::XMPP2::IM::Message->new (body => $msg);
177			}
178
179			if (defined $dest_jid) {
180			my $jid = stringprep_jid $dest_jid
181			or die "send_message: \$dest_jid is not a proper JID";
182			$msg->to ($jid);
183			}
184
185			my $srcacc;
186			if (ref $src) {
187			$srcacc = $src;
188			} elsif (defined $src) {
189			$srcacc = $self->get_account ($src)
190			} else {
191			$srcacc = $self->find_account_for_dest_jid ($dest_jid);
192			}
193
194			unless ($srcacc && $srcacc->is_connected) {
195			die "send_message: Couldn't get connected account for sending"
196			}
197
198			$msg->send ($srcacc->connection)
199			}
200
201			=item get_account ($jid)
202
203			Returns the L<Net::XMPP2::IM::Account> account object for the JID C<$jid>
204			if there is any such account added. (returns undef otherwise).
205
206			=cut
207
208			sub get_account {
209			my ($self, $jid) = @_;
210			$self->{accounts}->{prep_bare_jid $jid}
211			}
212
213			sub find_account_for_dest_jid {
214			my ($self, $jid) = @_;
215
216			my $any_acc;
217			for my $acc (values %{$self->{accounts}}) {
218			next unless $acc->is_connected;
219
220			# take "first" active account
221			$any_acc = $acc unless defined $any_acc;
222
223			my $roster = $acc->connection ()->get_roster;
224			if (my $c = $roster->get_contact ($jid)) {
225			return $acc;
226			}
227			}
228
229			$any_acc
230	elmex	1.1	}
231
232			=head1 EVENTS
233
234			These events can be registered on with C<reg_cb>:
235
236	elmex	1.2	In the following event descriptions the argument C<$account>
237			is always a L<Net::XMMP2::IM::Account> object.
238
239	elmex	1.1	=over 4
240
241	elmex	1.2	=item connected => $account
242
243			This event is sent when the C<$account> was successfully connected.
244
245			=item connect_error => $account
246
247			This event is emitted when an error occured in the connection process for the
248			account C<$account>.
249
250			=item error => $account
251
252			This event is emitted when any error occured while communicating
253			over the connection to the C<$account> - after a connection was established.
254
255			=item presence_update => $account, $roster, $contact, $old_presence, $new_presence
256	elmex	1.1
257	elmex	1.2	This event is emitted when a presence update was received on the C<$account>.
258			For a description of the other argument please look at the documentation
259			of the C<presence_update> event in L<Net::XMPP2::IM::Connection>.
260	elmex	1.1
261	elmex	1.2	=item message => $account, $msg
262	elmex	1.1
263	elmex	1.2	This event is emited when a message has been received on the C<$account>.
264			C<$msg> is a L<Net::XMPP2::IM::Message> object.
265	elmex	1.1
266			=back
267
268			=head1 AUTHOR
269
270			Robin Redeker, C<< <elmex at ta-sa.org> >>
271
272			=head1 COPYRIGHT & LICENSE
273
274			Copyright 2007 Robin Redeker, all rights reserved.
275
276			This program is free software; you can redistribute it and/or modify it
277			under the same terms as Perl itself.
278
279			=cut
280
281			1; # End of Net::XMPP2::Client