lib/Net/XMPP2.pm

package Net::XMPP2;
use warnings;
use strict;

=head1 NAME

Net::XMPP2 - An implementation of the XMPP Protocol

=head1 VERSION

Version 0.01

=cut

our $VERSION = '0.01';

=head1 SYNOPSIS

   use Net::XMPP2::Connection;

or:

   use Net::XMPP2::IM::Connection;

or:

   use Net::XMPP2::Client;

=head1 DESCRIPTION

This is the head module of the L<Net::XMPP2> XMPP client protocol (as described in
RFC 3920 and RFC 3921) framework.

L<Net::XMPP2::Connection> is a RFC 3920 conformant "XML" stream implementation
for clients, which handles TCP connect up to the resource binding. And provides
low level access to the XML nodes on the XML stream along with some high
level methods to send the predefined XML stanzas.

L<Net::XMPP2::IM::Connection> is a more high level module, which is derived
from L<Net::XMPP2::Connection>. It handles all the instant messaging client
functionality described in RFC 3921.

L<Net::XMPP2::Client> is a multi account client class. It manages connections
to multiple XMPP accounts and tries to offer a nice high level interface
to XMPP communication.

For a list of L</Supported extensions> see below.

There are also other modules in this distribution, for example:
L<Net::XMPP2::Util>, L<Net::XMPP2::Writer>, L<Net::XMPP2::Parser> and those I
forgot :-) Those modules might be helpful and/or required if you want to use
this framework for XMPP.

See also L<Net::XMPP2::Writer> for a discussion about the brokeness of XML in the XMPP
specification.

If you have any questions or seek for help look below under L</SUPPORT>.

=head1 REQUIREMENTS

One of the major drawbacks I see for Net::XMPP2 is the long list of required
modules to make it work.

=over 4

=item L<AnyEvent>

For the I/O events and timers.

=item L<XML::Writer>

For writing "XML".

=item L<XML::Parser::Expat>

For parsing partial "XML" stuff.

=item L<MIME::Base64>

For SASL authentication

=item L<Authen::SASL>

For SASL authentication

=item L<Net::LibIDN>

For stringprep profiles to handle JIDs.

=item L<Net::SSLeay>

For SSL connections.

=item L<Net::DNS>

For SRV RR lookups.

=back

And yes, all these are essential for XMPP communication. Even though 'instant
messaging' and 'presence' is a quite simple problem XMPP somehow was successful
at making the task complicated enough to keep me busy for a long time.  But all
of that time wasn't only for the technology required to get it started, mostly
it was for all the quirks, hacks and badly applied "XML" in the protocol which
complicated the matter.

=head1 RELEASE NOTES

Here are some notes to the releases (release of this version is at top):

=head2 Version

=over 4

=item * 0.01

This release has beta status. The code is already used daily in my client
and I keep looking out for bugs. If you find undocumented, missing or faulty
code/methods please drop me a mail! See also L</BUGS> below.

Potential edges when using this module: sparely documented methods, missing
functionality and generally bugs bugs and bugs. Even though this module is in
daily usage there are still lots of cases I might have missed.

For the next release I'm planning to provide more examples in the documentation
and/or samples/ directory, along with bugfixes and enhancements along with some
todo items killed from the TODO file.

=back

=head2 TODO

There are still lots of items on the TODO list (see also the TODO file
in the distribution of Net::XMPP2).

=head1 Why (yet) another XMPP module?

The main outstanding feature of this module in comparison to the other XMPP
(aka Jabber) modules out there is the support for L<AnyEvent>. L<AnyEvent>
permits you to use this module together with other I/O event based programs and
libraries (ie. L<Gtk2> or L<Event>).

The other modules could often only be integrated in those applications or
libraries by using threads. I decided to write this module because I think CPAN
lacks an event based XMPP module. Threads are unfortunately not an alternative
in Perl at the moment due the limited threading functionality they provide and
the global speed hit. I also think that a simple event based I/O framework
might be a bit easier to handle than threads.

Another thing was that I didn't like the APIs of the other modules. In L<Net::XMPP2>
I try to provide low level modules for speaking XMPP as defined in RFC 3920 and RFC 3921
(see also L<Net::XMPP2::Connection> and L<Net::XMPP2::IM::Connection>). But I also
try to provide a high level API for easier usage for instant messaging tasks
and clients (eg. L<Net::XMPP2::Client>).

=head1 A note about TLS

This module also supports TLS, as the specification of XMPP requires an
implementation to support TLS.

Maybe there are still some bugs in the handling of TLS in L<Net::XMPP2::Connection>.
So keep an eye on TLS with this module. If you encounter any problems it would be
very helpful if you could debug them or at least send me a detailed report on how
to reproduce the problem.

(As I use this module myself I don't expect TLS to be completly broken, but it
might break under different circumstances than I have here.  Those
circumstances might be a different load of data pumped through the TLS
connection.)

I mainly expect problems where available data isn't properly read from the socket
or written to it. You might want to take a look at the C<debug_send> and C<debug_recv>
events in L<Net::XMPP2::Connection>.

=head1 Supported extensions

See L<Net::XMPP2::Ext> for a list.

=head1 EXAMPLES

Following examples are included in this distribution:

=over 4

=item B<samples/simple_example_1>

This example script just connects to a server and sends a message and
also displays incoming messages on stdout.

=item B<samples/devcl/devcl>

This is a more advanced 'example'. It requires you to have L<Gtk2>
installed. It's mostly used by the author to implement proof-of-concepts.
Currently you start the client like this:

   ../Net-XMPP2/samples/devcl/# perl ./devcl <jid> <password>

The client's main window displays a protocol dump and there is currently
a service discovery browser implemented.

This might be a valuable source if you look for more real-world
applications of L<Net::XMPP2>.

=item B<samples/conference_lister>

See below.

=item B<samples/room_lister>

See below.

=item B<samples/room_lister_stat>

These three scripts implements a global room scan.  C<conference_lister> takes
a list of servers (the file is called C<servers.xml> which has the same format as
the xml file at L<http://www.jabber.org/servers.xml>). It then scans all
servers for chat room services and lists them into a file C<conferences.stor>,
which is a L<Storable> dump.

C<room_lister> then reads that file and queries all services for rooms, and then
all rooms for their occupants. The output file is C<room_data.stor>, also a L<Storable>
dump, which in turn can be read with C<room_lister_stat>, which transform
the data structures into something human readable.

These scripts are a bit hacky and quite complicated, but maybe it's of any
value for someone. You might note L<samples/EVQ.pm> which is a module that
handles request-throttling (You don't want to flood the server and risk
getting the admins attention :).

=back

For others, which the author might forgot or didn't want to
list here see the C<samples/> directory.

More examples will be included in later releases, please feel free to ask the
L</AUTHOR> if you have any questions about the API. There is also an IRC
channel, see L</SUPPORT>.

=head1 AUTHOR

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

=head1 BUGS

Please note that I'm currently (July 2007) the only developer on this project
and I'm very busy with my studies in Computer Science in Summer 2007. If you
want to ease my workload or want timely releases, please send me patches instead
of bug reports or feature requests. I won't forget the reports or requests if
you can't or didn't send patches, but it can take a long time until I get enough
time to fix/implement them.

Also try to be as precise as possible with bug reports, if you can't send a
patch, it would be best if you find out which code doesn't work and tell me
why.

Please report any bugs or feature requests to
C<bug-net-xmpp2 at rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-XMPP2>.
I will be notified and then you'll automatically be notified of progress on
your bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Net::XMPP2

You can also look for information at:

=over 4

=item * IRC: Net::XMPP2 IRC Channel

  IRC Network: http://freenode.net/
  Server     : chat.freenode.net
  Channel    : #net_xmpp2

  Feel free to join and ask questions!

=item * Net::XMPP2 Project Site

L<http://www.ta-sa.org/>

=item * AnnoCPAN: Annotated CPAN documentation

L<http://annocpan.org/dist/Net-XMPP2>

=item * CPAN Ratings

L<http://cpanratings.perl.org/d/Net-XMPP2>

=item * RT: CPAN's request tracker

L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-XMPP2>

=item * Search CPAN

L<http://search.cpan.org/dist/Net-XMPP2>

=back

=head1 ACKNOWLEDGEMENTS

Thanks to the XSF for the development of an open instant messaging protocol (even though it uses "XML").

And thanks to all people who had to listen to my desperate curses about the
brokenness/braindeadness of XMPP. Without you I would've never brought this
module to a usable state.

Thanks to:

=over 4

=item * Carlo von Loesch (aka lynX) L<http://www.psyced.org/>

For pointing out some typos.

=back

=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
Revision:	1.19
Committed:	Wed Jul 11 20:33:51 2007 UTC (19 years, 3 months ago) by elmex
Branch:	MAIN
Changes since 1.18:	+57 -3 lines
Log Message:	added some documentation for the examples.
#	User	Rev	Content
1	elmex	1.1	package Net::XMPP2;
2			use warnings;
3			use strict;
4
5			=head1 NAME
6
7			Net::XMPP2 - An implementation of the XMPP Protocol
8
9			=head1 VERSION
10
11			Version 0.01
12
13			=cut
14
15			our $VERSION = '0.01';
16
17			=head1 SYNOPSIS
18
19	elmex	1.2	use Net::XMPP2::Connection;
20	elmex	1.1
21	elmex	1.2	or:
22	elmex	1.1
23	elmex	1.2	use Net::XMPP2::IM::Connection;
24	elmex	1.1
25	elmex	1.11	or:
26
27			use Net::XMPP2::Client;
28
29	elmex	1.2	=head1 DESCRIPTION
30
31			This is the head module of the L<Net::XMPP2> XMPP client protocol (as described in
32	elmex	1.4	RFC 3920 and RFC 3921) framework.
33	elmex	1.2
34	elmex	1.4	L<Net::XMPP2::Connection> is a RFC 3920 conformant "XML" stream implementation
35	elmex	1.18	for clients, which handles TCP connect up to the resource binding. And provides
36			low level access to the XML nodes on the XML stream along with some high
37	elmex	1.5	level methods to send the predefined XML stanzas.
38	elmex	1.2
39	elmex	1.18	L<Net::XMPP2::IM::Connection> is a more high level module, which is derived
40	elmex	1.4	from L<Net::XMPP2::Connection>. It handles all the instant messaging client
41	elmex	1.5	functionality described in RFC 3921.
42
43	elmex	1.11	L<Net::XMPP2::Client> is a multi account client class. It manages connections
44	elmex	1.18	to multiple XMPP accounts and tries to offer a nice high level interface
45	elmex	1.11	to XMPP communication.
46
47	elmex	1.17	For a list of L</Supported extensions> see below.
48	elmex	1.2
49			There are also other modules in this distribution, for example:
50	elmex	1.11	L<Net::XMPP2::Util>, L<Net::XMPP2::Writer>, L<Net::XMPP2::Parser> and those I
51	elmex	1.2	forgot :-) Those modules might be helpful and/or required if you want to use
52			this framework for XMPP.
53
54			See also L<Net::XMPP2::Writer> for a discussion about the brokeness of XML in the XMPP
55			specification.
56
57	elmex	1.15	If you have any questions or seek for help look below under L</SUPPORT>.
58
59	elmex	1.12	=head1 REQUIREMENTS
60
61			One of the major drawbacks I see for Net::XMPP2 is the long list of required
62			modules to make it work.
63
64			=over 4
65
66	elmex	1.15	=item L<AnyEvent>
67	elmex	1.12
68			For the I/O events and timers.
69
70	elmex	1.15	=item L<XML::Writer>
71	elmex	1.12
72			For writing "XML".
73
74	elmex	1.15	=item L<XML::Parser::Expat>
75	elmex	1.12
76			For parsing partial "XML" stuff.
77
78	elmex	1.15	=item L<MIME::Base64>
79	elmex	1.12
80			For SASL authentication
81
82	elmex	1.15	=item L<Authen::SASL>
83	elmex	1.12
84			For SASL authentication
85
86	elmex	1.15	=item L<Net::LibIDN>
87	elmex	1.12
88			For stringprep profiles to handle JIDs.
89
90	elmex	1.15	=item L<Net::SSLeay>
91	elmex	1.12
92			For SSL connections.
93
94	elmex	1.15	=item L<Net::DNS>
95	elmex	1.12
96			For SRV RR lookups.
97
98			=back
99
100	elmex	1.18	And yes, all these are essential for XMPP communication. Even though 'instant
101	elmex	1.12	messaging' and 'presence' is a quite simple problem XMPP somehow was successful
102	elmex	1.18	at making the task complicated enough to keep me busy for a long time. But all
103			of that time wasn't only for the technology required to get it started, mostly
104			it was for all the quirks, hacks and badly applied "XML" in the protocol which
105	elmex	1.12	complicated the matter.
106
107	elmex	1.11	=head1 RELEASE NOTES
108
109			Here are some notes to the releases (release of this version is at top):
110
111			=head2 Version
112
113			=over 4
114
115	elmex	1.15	=item * 0.01
116	elmex	1.11
117			This release has beta status. The code is already used daily in my client
118			and I keep looking out for bugs. If you find undocumented, missing or faulty
119	elmex	1.15	code/methods please drop me a mail! See also L</BUGS> below.
120	elmex	1.11
121	elmex	1.14	Potential edges when using this module: sparely documented methods, missing
122	elmex	1.18	functionality and generally bugs bugs and bugs. Even though this module is in
123	elmex	1.11	daily usage there are still lots of cases I might have missed.
124
125			For the next release I'm planning to provide more examples in the documentation
126	elmex	1.14	and/or samples/ directory, along with bugfixes and enhancements along with some
127	elmex	1.11	todo items killed from the TODO file.
128
129			=back
130
131			=head2 TODO
132
133			There are still lots of items on the TODO list (see also the TODO file
134	elmex	1.14	in the distribution of Net::XMPP2).
135	elmex	1.11
136	elmex	1.2	=head1 Why (yet) another XMPP module?
137
138	elmex	1.17	The main outstanding feature of this module in comparison to the other XMPP
139	elmex	1.2	(aka Jabber) modules out there is the support for L<AnyEvent>. L<AnyEvent>
140			permits you to use this module together with other I/O event based programs and
141			libraries (ie. L<Gtk2> or L<Event>).
142
143	elmex	1.18	The other modules could often only be integrated in those applications or
144			libraries by using threads. I decided to write this module because I think CPAN
145			lacks an event based XMPP module. Threads are unfortunately not an alternative
146			in Perl at the moment due the limited threading functionality they provide and
147			the global speed hit. I also think that a simple event based I/O framework
148			might be a bit easier to handle than threads.
149	elmex	1.2
150			Another thing was that I didn't like the APIs of the other modules. In L<Net::XMPP2>
151	elmex	1.9	I try to provide low level modules for speaking XMPP as defined in RFC 3920 and RFC 3921
152			(see also L<Net::XMPP2::Connection> and L<Net::XMPP2::IM::Connection>). But I also
153	elmex	1.11	try to provide a high level API for easier usage for instant messaging tasks
154	elmex	1.15	and clients (eg. L<Net::XMPP2::Client>).
155	elmex	1.2
156			=head1 A note about TLS
157
158			This module also supports TLS, as the specification of XMPP requires an
159	elmex	1.7	implementation to support TLS.
160	elmex	1.2
161	elmex	1.18	Maybe there are still some bugs in the handling of TLS in L<Net::XMPP2::Connection>.
162	elmex	1.7	So keep an eye on TLS with this module. If you encounter any problems it would be
163			very helpful if you could debug them or at least send me a detailed report on how
164			to reproduce the problem.
165
166			(As I use this module myself I don't expect TLS to be completly broken, but it
167			might break under different circumstances than I have here. Those
168			circumstances might be a different load of data pumped through the TLS
169			connection.)
170	elmex	1.1
171	elmex	1.18	I mainly expect problems where available data isn't properly read from the socket
172	elmex	1.2	or written to it. You might want to take a look at the C<debug_send> and C<debug_recv>
173			events in L<Net::XMPP2::Connection>.
174	elmex	1.1
175	elmex	1.17	=head1 Supported extensions
176	elmex	1.3
177	elmex	1.10	See L<Net::XMPP2::Ext> for a list.
178	elmex	1.3
179	elmex	1.16	=head1 EXAMPLES
180
181	elmex	1.19	Following examples are included in this distribution:
182
183			=over 4
184
185			=item B<samples/simple_example_1>
186
187			This example script just connects to a server and sends a message and
188			also displays incoming messages on stdout.
189
190			=item B<samples/devcl/devcl>
191
192			This is a more advanced 'example'. It requires you to have L<Gtk2>
193			installed. It's mostly used by the author to implement proof-of-concepts.
194			Currently you start the client like this:
195
196			../Net-XMPP2/samples/devcl/# perl ./devcl <jid> <password>
197
198			The client's main window displays a protocol dump and there is currently
199			a service discovery browser implemented.
200
201			This might be a valuable source if you look for more real-world
202			applications of L<Net::XMPP2>.
203
204			=item B<samples/conference_lister>
205
206			See below.
207
208			=item B<samples/room_lister>
209
210			See below.
211
212			=item B<samples/room_lister_stat>
213
214			These three scripts implements a global room scan. C<conference_lister> takes
215			a list of servers (the file is called C<servers.xml> which has the same format as
216			the xml file at L<http://www.jabber.org/servers.xml>). It then scans all
217			servers for chat room services and lists them into a file C<conferences.stor>,
218			which is a L<Storable> dump.
219
220			C<room_lister> then reads that file and queries all services for rooms, and then
221			all rooms for their occupants. The output file is C<room_data.stor>, also a L<Storable>
222			dump, which in turn can be read with C<room_lister_stat>, which transform
223			the data structures into something human readable.
224
225			These scripts are a bit hacky and quite complicated, but maybe it's of any
226			value for someone. You might note L<samples/EVQ.pm> which is a module that
227			handles request-throttling (You don't want to flood the server and risk
228			getting the admins attention :).
229
230			=back
231
232			For others, which the author might forgot or didn't want to
233			list here see the C<samples/> directory.
234
235			More examples will be included in later releases, please feel free to ask the
236			L</AUTHOR> if you have any questions about the API. There is also an IRC
237			channel, see L</SUPPORT>.
238	elmex	1.16
239	elmex	1.1	=head1 AUTHOR
240
241	elmex	1.11	Robin Redeker, C<< <elmex at ta-sa.org> >>, JID: C<< <elmex at jabber.org> >>
242	elmex	1.1
243			=head1 BUGS
244
245	elmex	1.12	Please note that I'm currently (July 2007) the only developer on this project
246			and I'm very busy with my studies in Computer Science in Summer 2007. If you
247	elmex	1.18	want to ease my workload or want timely releases, please send me patches instead
248			of bug reports or feature requests. I won't forget the reports or requests if
249			you can't or didn't send patches, but it can take a long time until I get enough
250	elmex	1.12	time to fix/implement them.
251
252	elmex	1.18	Also try to be as precise as possible with bug reports, if you can't send a
253			patch, it would be best if you find out which code doesn't work and tell me
254			why.
255	elmex	1.12
256	elmex	1.1	Please report any bugs or feature requests to
257			C<bug-net-xmpp2 at rt.cpan.org>, or through the web interface at
258			L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-XMPP2>.
259	elmex	1.18	I will be notified and then you'll automatically be notified of progress on
260	elmex	1.1	your bug as I make changes.
261
262			=head1 SUPPORT
263
264			You can find documentation for this module with the perldoc command.
265
266			perldoc Net::XMPP2
267
268			You can also look for information at:
269
270			=over 4
271
272	elmex	1.15	=item * IRC: Net::XMPP2 IRC Channel
273
274			IRC Network: http://freenode.net/
275			Server : chat.freenode.net
276			Channel : #net_xmpp2
277
278	elmex	1.16	Feel free to join and ask questions!
279
280	elmex	1.15	=item * Net::XMPP2 Project Site
281
282			L<http://www.ta-sa.org/>
283
284	elmex	1.1	=item * AnnoCPAN: Annotated CPAN documentation
285
286			L<http://annocpan.org/dist/Net-XMPP2>
287
288			=item * CPAN Ratings
289
290			L<http://cpanratings.perl.org/d/Net-XMPP2>
291
292			=item * RT: CPAN's request tracker
293
294			L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-XMPP2>
295
296			=item * Search CPAN
297
298			L<http://search.cpan.org/dist/Net-XMPP2>
299
300			=back
301
302			=head1 ACKNOWLEDGEMENTS
303
304	elmex	1.18	Thanks to the XSF for the development of an open instant messaging protocol (even though it uses "XML").
305	elmex	1.13
306			And thanks to all people who had to listen to my desperate curses about the
307	elmex	1.18	brokenness/braindeadness of XMPP. Without you I would've never brought this
308	elmex	1.13	module to a usable state.
309	elmex	1.12
310	elmex	1.17	Thanks to:
311
312			=over 4
313
314	elmex	1.18	=item * Carlo von Loesch (aka lynX) L<http://www.psyced.org/>
315	elmex	1.17
316			For pointing out some typos.
317
318			=back
319
320	elmex	1.1	=head1 COPYRIGHT & LICENSE
321
322			Copyright 2007 Robin Redeker, all rights reserved.
323
324			This program is free software; you can redistribute it and/or modify it
325			under the same terms as Perl itself.
326
327			=cut
328
329			1; # End of Net::XMPP2