blib/lib/Net/SloppyXMPP.pm

filter: Statementstmt 4.6% 19 / 413 Branchbran 0.0% 0 / 164 Conditioncond 0.0% 0 / 98 MC/DCmcdc 0.0% 0 / 54 Subroutinesub 13.6% 6 / 44 Podpod 100% 36 / 36 totaltotal 7.5% 61 / 809 CC 121 SCAR 61.4
CC
121
Cov
3%
process_read_queue
1332.0
new
870.0
connect
72.0
CRAP 463.6
↑ Summary
1 package Net::SloppyXMPP;
2  
3 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 1 ▶use Encode;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 1 ▶use IO::Socket::INET;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 1 ▶use XML::Simple;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 1 ▶use Data::Dumper;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 1 our $VERSION = '0.06';
11  
12 =head1 NAME
13  
14 Net::SloppyXMPP - A rather sloppy XMPP client implementation
15  
16 =head1 DESCRIPTION
17  
18 In an attempt to drastically reduce external dependencies, this module doesn't use a lot of them.
19 Therefore, it doesn't do a whole lot via proper standards.
20  
21 The XML parser is a combination of a mess of regex hacks and some processing through XML::Simple.
22  
23 XML namespaces aren't really used properly.
24  
25 There's no guarantee that this will work for anything.
26  
27 Reinventing the wheel? You betcha. Unfortunately, neither L<Net::XMPP> nor L<AnyEvent::XMPP> would
28 work in the fashion I needed. It doesn't help that L<Net::XMPP> is unmaintained (or so it seems)
29 these days. L<AnyEvent::XMPP> requires LibIDN, which has been too big of an issue to deal with
30 where I'm needing to implement an XMPP client.
31  
32 SASL and TLS are both available, but not required. Just disable one or both of them if you don't
33 want or can't use them. SASL features are provided via L<Authen::SASL> and are only used if
34 C<usesasl> is true (it's true unless you specifically set it to false). TLS features are provided
35 via L<Net::SSLeay> and are only used if C<usetls> is true (it's true unless you specifically set
36 it to false).
37  
38 One of the goals of this implementation is to ensure that it will work on as many platforms as possible,
39 especially those that can't use a few of the dependencies of the other XMPP modules available for Perl.
40  
41 =head1 WHO SHOULD USE THIS?
42  
43 Probably no one. It's sloppy. It's untested. It's incomplete. But if the description above didn't
44 scare you away, you might be a good candidate. You'll probably need to track down some bugs in it
45 before you can really use it. If you're using Openfire 3.6.2 as an XMPP server, you might have good
46 luck in using it straight away. If you're using Google's XMPP service, you won't have any luck (yet).
47  
48 If you really want to use this module, but it doesn't work for you, please post your troubles on the
49 CPAN bug tracker. If you need support for additional XMPP servers, I'd love to add such support.
50 To do that, I might need access to the XMPP server with a test username/password. I'd really rather not
51 setup loads of XMPP servers for testing purposes. Providing me with a test account will help the process
52 of adding additional XMPP servers.
53  
54 But like I said, maybe no one should be using this module. Other seemingly good XMPP modules are
55 available on CPAN. Some examples: L<Net::XMPP> and L<AnyEvent::XMPP>.
56  
57 =head1 EXAMPLE
58  
59 use Net::SloppyXMPP;
60  
61 my $xmpp = Net::SloppyXMPP->new(
62 debug => 1,
63 tickdelay => 1,
64 #usetls => 0, # set this if you don't want TLS
65 #usesasl => 0, # set this if you don't want SASL
66 domain => 'yourdomain.xyz',
67 username => 'yourusername',
68 password => 'yourpassword',
69 resource => 'yourresourcename', # or don't set and a default will be supplied
70 initialpresence => 'available', # available, busy, dnd, defaults to available
71 initialstatus => 'I am alive!', # defaults to ''
72 message_callback => \&messageCallback,
73 );
74 die qq(XMPP didn't create.\n) unless $xmpp;
75  
76 sub messageCallback
77 {
78 my $xmpp = shift;
79 my $data = shift;
80 print Dumper($data);
81 }
82  
83 my $xmppConnect = $xmpp->connect;
84 die qq(XMPP didn't connect.\n) unless $xmppConnect;
85  
86 # if you want SloppyXMPP to control your main loop
87 $xmpp->run(\&tick);
88 sub tick
89 {
90 # do stuff in here that needs to happen each loop (use as a main loop)
91 my $xmpp = shift; # if you need it, same object as the $xmpp you already used
92 print "This runs every $xmpp->{tickdelay} seconds.\n";
93 }
94  
95 # or if you want to run your own loop, do this:
96 sub loop
97 {
98 print "Doing something useful here...\n";
99  
100 # ... more useful code ...
101  
102 $xmpp->tick; # runs the SloppyXMPP loop once
103  
104 # ... and more useful code ...
105 }
106 loop();
107  
108 =head1 ABSTRACT
109  
110 Not complete, just like the module itself. Feel free to read the source code to figure out how to
111 use it. A bit of help is sprinkled about the page below.
112  
113 B<WARNING:> Most of these functions are internal functions not to be used outside of the module.
114 If you use them yourself, I don't want to get bug reports about it. If it just says
115 "C<Used internally>" but doesn't say you can't use it, you're probably okay to use it. If it says
116 something like "C<Don't use it yourself>", don't use it. You're likely to upset the delicate
117 balance of nature and might cause mass casualties, famine, hurricanes, tornadoes, floods, or drought.
118 You've been warned.
119  
120 If you've avoided my warning above and are using a function that you really have no business using,
121 let me know (see my contact info at the end of this doc) so I can create a more proper interface
122 into whatever it is that you're doing improperly.
123  
124 =head2 new
125  
126 my $xmpp = Net::SloppyXMPP->new(
127 someoption => "somevalue", # see below
128 anotheroption => "anothervalue", # for the options
129 );
130  
131 =over
132  
133 =item usetls
134  
135 Specify the use of TLS.
136 TLS requires L<Net::SSLeay>, but it'll only be loaded if this is true.
137 Your XMPP server must support TLS.
138 Default true if not set.
139  
140 =item usesasl
141  
142 Specify the use of SASL for authentication.
143 SASL requires L<Authen::SASL> and L<MIME::Base64>, but they'll only be loaded if this is true.
144 Your XMPP server must support SASL.
145 Default true if not set.
146  
147 =item usesrv
148  
149 Specify the use of SRV records to determine XMPP host/port based on domain.
150 This requires L<Megagram::ResolveSRV>, but it'll only be loaded if this is true.
151 If your domain doesn't use C<_xmpp-client._tcp.yourdomain.com> SRV records, this will fail.
152 Default true if not set.
153  
154 =item domain
155  
156 The domain.
157 If your XMPP user is C<fred@yourdomain.xyz>, the domain is C<yourdomain.xyz>.
158 I<A required variable>.
159  
160 =item host
161  
162 The IP/domain of the XMPP server to connect to.
163 You can use either C<"yourdomain.xyz"> or C<"yourdomain.xyz:5222"> formats.
164 If you're using SRV records (see C<usesrv> above), don't set this.
165 I<A required variable>, but only if C<usesrv> is false.
166  
167 =item port
168  
169 The port of the XMPP server to connect to.
170 If you've set the port number along with the host (see C<host> above), don't set this.
171 If you're using SRV records (see C<usesrv> above), don't set this.
172 I<A required variable>, but only if C<usesrv> is false.
173  
174 =item username
175  
176 The username.
177 If your XMPP user is C<fred@yourdomain.xyz>, the username is C<fred>.
178 I<A required variable>.
179  
180 =item password
181  
182 The password.
183 This probably doesn't need introduction.
184 I<A required variable>.
185  
186 =item resource
187  
188 The resource.
189 If you don't know what this is, you probably don't need to set it.
190 In the JID C<fred@yourdomain.xyz/Office>, the resource is C<Office>.
191 A default is provided if you don't set it.
192  
193 =item message_callback
194  
195 The function or code that you want to run on each incoming message.
196 Must be a coderef.
197 A default (NOOP with complaint) provided if you don't set it.
198  
199 =item debug
200  
201 The debug level.
202 The higher the number, the more debug messages you'll get.
203 If you don't want to get I<any> messages, set it to -1.
204 Default is C<0>.
205  
206 =item tickdelay
207  
208 The delay in the C<run> loop, in floating-point seconds.
209 If you don't use C<run> (see below), you won't need this.
210 Default is C<0.5> seconds.
211  
212 =item initialpresence
213  
214 Your initial presence on the XMPP server upon connection.
215 Set it to any valid presence value (such as C<available>, C<dnd>, C<away>).
216 Can be changed at any time while connected via the C<presence> function (see below).
217 Default is C<available>.
218  
219 =item initialstatus
220  
221 Your initial status message on the XMPP server upon connection.
222 Set it to some string.
223 Can be changed at any time while connected via the C<presence> function (see below).
224 Default is empty string.
225  
226 =item socket_write_len
227  
228 If you don't know what this is for, don't mess with it.
229 Sets the amount to write to the socket at one time.
230 Default is C<4096>.
231  
232 =item socket_read_len
233  
234 If you don't know what this is for, don't mess with it.
235 Sets the amount to read from the socket at one time.
236 Default is C<4096>.
237  
238 =item pingfreq
239  
240 If you don't know what this is for, don't mess with it.
241 Sets the number of seconds between automatic pings.
242 Set it to C<0> if you wish to disable it.
243 Default is C<300> seconds (5 minutes).
244  
245 =back
246  
247 =cut
248  
249 sub new
250 0 ▶{
Subroutine new: not called CC=29 SCAR=67.7
Pod documented
251 0 my $class = shift;
252 0 my %args = @_;
253 0 my $self = bless({}, $class);
254  
255 0 ▶ $self->{debug} = $args{debug} || 0;
Condition0%0/2
$args{'debug'} || 0
l!l
00
MC/DC0%0/1
$args{'debug'} || 0
$args{'debug'}
Truth table0%0/2
A
A= $args{'debug'}
Aresult
11
00
256  
257 0 ▶ $self->{tickdelay} = int((defined($args{tickdelay}) ? $args{tickdelay} : 0.5) * 100) / 100 || 0.5;
Branch: 1 branch
BranchTrueFalseTotal
defined $args{'tickdelay'} ? : 0 0 0
Condition0%0/2
int((defined $args{'tickdelay'} ? $args{'tickdelay'} : 0.5) * 100) / 100 || 0.5
l!l
00
MC/DC0%0/1
int((defined $args{'tickdelay'} ? $args{'tickdelay'} : 0.5) * 100) / 100 || 0.5
int((defined $args{'tickdelay'} ? $args{'tickdelay'} : 0.5) * 100) / 100
Truth table0%0/2
A
A= int((defined $args{'tickdelay'} ? $args{'tickdelay'} : 0.5) * 100) / 100
Aresult
11
00
258 0 ▶ $self->{tick_callback} = sub { $self->debug(0, __PACKAGE__." has no tick callback."); };
Subroutine __ANON__: not called CC=1 SCAR=6.9
259  
260 0 $self->{pingtimer} = time();
261 0 ▶ $self->{pingfreq} = (defined($args{pingfreq}) ? abs($args{pingfreq}) : 300);
Branch: 1 branch
BranchTrueFalseTotal
defined $args{'pingfreq'} ? : 0 0 0
262  
263 0 ▶ $self->{message_callback} = sub { $self->debug(0, __PACKAGE__." has no message callback."); };
Subroutine __ANON__: not called CC=1 SCAR=6.9
264 0 ▶ if (defined($args{message_callback}))
Branch: 1 branch
BranchTrueFalseTotal
if (defined $args{"message_callback"}) 0 0 0
265 {
266 0 ▶ if (ref($args{message_callback}) eq 'CODE')
Branch: 1 branch
BranchTrueFalseTotal
if (ref $args{'message_callback'} eq 'CODE') { } 0 0 0
267 {
268 0 $self->{message_callback} = $args{message_callback};
269 }
270 else
271 {
272 0 $self->debug(0, __PACKAGE__."->new message_callback must be coderef.");
273 0 return 0;
274 }
275 }
276  
277 0 @{$self->{write_queue}} = ();
278 0 @{$self->{read_queue}} = ();
279 0 $self->{read_buffer} = '';
280  
281 0 ▶ $self->{usetls} = (defined($args{usetls}) ? $args{usetls} : 1);
Branch: 1 branch
BranchTrueFalseTotal
defined $args{'usetls'} ? : 0 0 0
282 0 ▶ $self->{usesrv} = (defined($args{usesrv}) ? $args{usesrv} : 1);
Branch: 1 branch
BranchTrueFalseTotal
defined $args{'usesrv'} ? : 0 0 0
283 0 ▶ $self->{usesasl} = (defined($args{usesasl}) ? $args{usesasl} : 1);
Branch: 1 branch
BranchTrueFalseTotal
defined $args{'usesasl'} ? : 0 0 0
284  
285 0 ▶ if ($self->{usesrv})
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"usesrv"}) 0 0 0
286 {
287 0 require Megagram::ResolveSRV;
288 0 import Megagram::ResolveSRV;
289 0 $self->{rsrv} = Megagram::ResolveSRV->new;
290 }
291  
292 0 ▶ if ($self->{usetls})
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"usetls"}) 0 0 0
293 {
294 0 require Net::SSLeay;
295 0 import Net::SSLeay qw(die_if_ssl_error);
296  
297 #### NET::SSLeay is not really thread-safe it seems... fixable? FIXME
298  
299 0 Net::SSLeay::load_error_strings();
300 0 Net::SSLeay::SSLeay_add_ssl_algorithms();
301 0 Net::SSLeay::randomize();
302 0 $Net::SSLeay::ssl_version = 10; # Insist on TLSv1
303 }
304  
305 0 ▶ if ($self->{usesasl})
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"usesasl"}) 0 0 0
306 {
307 0 $self->debug(2, "We'll be using SASL for Authentication.");
308 eval
309 0 {
310 0 require Authen::SASL;
311 0 import Authen::SASL;
312 0 require MIME::Base64;
313 0 import MIME::Base64;
314 };
315 }
316  
317 $self->{domain} = $args{domain} or do
318 0 ▶ {
Branch: 1 branch
BranchTrueFalseTotal
$self->{"domain"} = $args{"domain"} or do { $self->debug(0, "Net::SloppyXMPP->new requires domain."); return 0 } 0 0 0
319 0 $self->debug(0, __PACKAGE__."->new requires domain.");
320 0 return 0;
321 };
322  
323 0 $self->{host} = $args{host};
324 0 $self->{port} = $args{port};
325  
326 0 ▶ if (defined($self->{host}) && $self->{host} =~ s/:(\d+)//)
Branch: 1 branch
BranchTrueFalseTotal
if (defined $self->{"host"} and $self->{"host"} =~ s/:(\d+)//) 0 0 0
Condition0%0/3
defined $self->{"host"} and $self->{"host"} =~ s/:(\d+)//
!ll&&!rl&&r
000
MC/DC0%0/2
defined $self->{"host"} and $self->{"host"} =~ s/:(\d+)//
defined $self->{"host"} $self->{"host"} =~ s/:(\d+)//
Truth table0%0/3
A and B
A= defined $self->{"host"}B= $self->{"host"} =~ s/:(\d+)//
ABresult
0X0
100
111
327 {
328 0 my $port = $1;
329 0 ▶ if ($self->{port})
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"port"}) 0 0 0
330 {
331 0 $self->debug(0, __PACKAGE__."->new uses either domain=host:port or domain=host, port=port, not both.");
332 0 return 0;
333 }
334 0 $self->{port} = $port;
335 }
336  
337 0 ▶ if ($self->{usesrv} && ($self->{host} || $self->{port}))
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"usesrv"} and $self->{"host"} || $self->{"port"}) 0 0 0
Condition0%0/6
$self->{"usesrv"} and $self->{"host"} || $self->{"port"}
!ll&&!rl&&r
000
$self->{"host"} or $self->{"port"}
l!l&&r!l&&!r
000
MC/DC0%0/3
$self->{"usesrv"} and $self->{"host"} || $self->{"port"}
$self->{"usesrv"} $self->{"host"} $self->{"port"}
Truth table0%0/4
A and B or C
A= $self->{"usesrv"}B= $self->{"host"}C= $self->{"port"}
ABCresult
0XX0
1000
11X1
1011
338 {
339 0 $self->debug(0, __PACKAGE__."->new does not accept host or port if usesrv is true.");
340 0 return 0;
341 }
342  
343 0 ▶ if (!$self->{usesrv} && (!$self->{host} || !$self->{port}))
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->{"usesrv"} or $self->{"host"} and $self->{"port"}) 0 0 0
Condition0%0/6
$self->{"usesrv"} or $self->{"host"} and $self->{"port"}
l!l&&r!l&&!r
000
$self->{"host"} and $self->{"port"}
!ll&&!rl&&r
000
MC/DC0%0/3
$self->{"usesrv"} or $self->{"host"} and $self->{"port"}
$self->{"usesrv"} $self->{"host"} $self->{"port"}
Truth table0%0/4
A or B and C
A= $self->{"usesrv"}B= $self->{"host"}C= $self->{"port"}
ABCresult
1XX1
0111
00X0
0100
344 {
345 0 $self->debug(0, __PACKAGE__."->new requires host and port (host=host:port or host=host, port=port) when usesrv is false.");
346 0 return 0;
347 }
348  
349 $self->{username} = $args{username} or do
350 0 ▶ {
Branch: 1 branch
BranchTrueFalseTotal
$self->{"username"} = $args{"username"} or do { $self->debug(0, "Net::SloppyXMPP->new requires username."); return 0 } 0 0 0
351 0 $self->debug(0, __PACKAGE__."->new requires username.");
352 0 return 0;
353 };
354 0 $self->{password} = $args{password};
355 0 ▶ $self->{resource} = $args{resource} || "Perl-Net-SimpleXMPP-$VERSION-".int(rand() * 100000);
Condition0%0/3
$args{'resource'} || "Perl-Net-SimpleXMPP-$Net::SloppyXMPP::VERSION-" . int((rand()) * 100000)
l!l&&r!l&&!r
000
MC/DC0%0/2
$args{'resource'} || "Perl-Net-SimpleXMPP-$Net::SloppyXMPP::VERSION-" . int((rand()) * 100000)
$args{'resource'} "Perl-Net-SimpleXMPP-$Net::SloppyXMPP::VERSION-" . int((rand()) * 100000)
Truth table0%0/3
A || B
A= $args{'resource'}B= "Perl-Net-SimpleXMPP-$Net::SloppyXMPP::VERSION-" . int((rand()) * 100000)
ABresult
1X1
011
000
356 0 ▶ $self->{initialpresence} = $args{initialpresence} || 'available';
Condition0%0/2
$args{'initialpresence'} || 'available'
l!l
00
MC/DC0%0/1
$args{'initialpresence'} || 'available'
$args{'initialpresence'}
Truth table0%0/2
A
A= $args{'initialpresence'}
Aresult
11
00
357 0 ▶ $self->{initialstatus} = $args{initialstatus} || '';
Condition0%0/2
$args{'initialstatus'} || ''
l!l
00
MC/DC0%0/1
$args{'initialstatus'} || ''
$args{'initialstatus'}
Truth table0%0/2
A
A= $args{'initialstatus'}
Aresult
11
00
358  
359 0 ▶ $self->{socket_write_len} = $args{socket_write_len} || 4096;
Condition0%0/2
$args{'socket_write_len'} || 4096
l!l
00
MC/DC0%0/1
$args{'socket_write_len'} || 4096
$args{'socket_write_len'}
Truth table0%0/2
A
A= $args{'socket_write_len'}
Aresult
11
00
360 0 ▶ $self->{socket_read_len} = $args{socket_read_len} || 4096;
Condition0%0/2
$args{'socket_read_len'} || 4096
l!l
00
MC/DC0%0/1
$args{'socket_read_len'} || 4096
$args{'socket_read_len'}
Truth table0%0/2
A
A= $args{'socket_read_len'}
Aresult
11
00
361  
362 0 $self->{xmpp_features} = {};
363 0 $self->{authenticated} = 0;
364 0 $self->{resourcebound} = 0;
365 0 $self->{sessionstarted} = 0;
366  
367 0 @{$self->{roster}} = ();
368  
369 0 return $self;
370 }
371  
372 =head2 debug
373  
374 Used internally.
375 B<Don't use it yourself.>
376 Debug messages are written to this function.
377 Debug messages only appear (via STDERR) when C<< ($debugvalue <= $xmpp-{debug}) >>.
378  
379 =cut
380  
381 sub debug
382 0 ▶{
Subroutine debug: not called CC=3 SCAR=24.8
Pod documented
383 0 my $self = shift;
384 0 ▶ my $level = shift || 1;
Condition0%0/2
shift() || 1
l!l
00
MC/DC0%0/1
shift() || 1
shift()
Truth table0%0/2
A
A= shift()
Aresult
11
00
385 0 ▶ return 0 unless ($level <= $self->{debug});
Branch: 1 branch
BranchTrueFalseTotal
unless $level <= $self->{"debug"} 0 0 0
386 0 my $text = shift;
387 0 warn $text."\n";
388 }
389  
390 =head2 connect
391  
392 Initiates the XMPP connection.
393  
394 =cut
395  
396 sub connect
397 0 ▶{
Subroutine connect: not called CC=8 SCAR=42.8
Pod documented
398 0 my $self = shift;
399  
400 0 my @hosts;
401  
402 0 ▶ if ($self->{usesrv})
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{'usesrv'}) { } 0 0 0
403 {
404 0 @hosts = $self->{rsrv}->resolve('_xmpp-client._tcp.'.$self->{domain});
405 0 ▶ return -1 unless ($hosts[0]); # no XMPP service listed
Branch: 1 branch
BranchTrueFalseTotal
unless $hosts[0] 0 0 0
406 }
407 else
408 {
409 0 @hosts = ({target => $self->{host}, port => $self->{port}});
410 }
411  
412 0 foreach my $host (@hosts)
413 {
414 0 my $target = $host->{target};
415 0 my $port = $host->{port};
416 0 $self->debug(3, "Connecting to $target:$port");
417 0 $self->{socket} = IO::Socket::INET->new(
418 PeerAddr => $target,
419 PeerPort => $port,
420 Proto => 'tcp',
421 Blocking => 1,
422 );
423 0 ▶ last if (defined($self->{socket}) && $self->{socket}->connected);
Branch: 1 branch
BranchTrueFalseTotal
if defined $self->{"socket"} and $self->{"socket"}->connected 0 0 0
Condition0%0/3
defined $self->{"socket"} and $self->{"socket"}->connected
!ll&&!rl&&r
000
MC/DC0%0/2
defined $self->{"socket"} and $self->{"socket"}->connected
defined $self->{"socket"} $self->{"socket"}->connected
Truth table0%0/3
A and B
A= defined $self->{"socket"}B= $self->{"socket"}->connected
ABresult
0X0
100
111
424 }
425  
426 0 ▶ unless (defined($self->{socket}) && $self->{socket}->connected)
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self->{"socket"} and $self->{"socket"}->connected) 0 0 0
Condition0%0/3
defined $self->{"socket"} and $self->{"socket"}->connected
!ll&&!rl&&r
000
MC/DC0%0/2
defined $self->{"socket"} and $self->{"socket"}->connected
defined $self->{"socket"} $self->{"socket"}->connected
Truth table0%0/3
A and B
A= defined $self->{"socket"}B= $self->{"socket"}->connected
ABresult
0X0
100
111
427 {
428 0 $self->debug(1, "SOCKETERROR: $!");
429 0 return 0;
430 }
431  
432 0 $self->{socket}->blocking(0); # set to non-blocking
433 0 binmode($self->{socket}, ':raw');
434  
435 0 $self->sendhandshake;
436  
437 0 return 1;
438 }
439  
440 =head2 sendhandshake
441  
442 Used internally.
443 B<Don't use it yourself.>
444 Sends the XMPP handshake.
445  
446 =cut
447  
448 sub sendhandshake
449 0 ▶{
Subroutine sendhandshake: not called CC=1 SCAR=6.9
Pod documented
450 0 my $self = shift;
451  
452 # start the handshake
453 0 $self->write(qq(<?xml version='1.0' ?><stream:stream version='1.0' xmlns:stream='http://etherx.jabber.org/streams' xmlns='jabber:client' to='$self->{domain}' xml:lang='en' />));
454 }
455  
456 =head2 check_socket_connected
457  
458 Used internally.
459 Checks to see if the socket is currently connected.
460 Doesn't test to see if the socket is TLS or not.
461  
462 =cut
463  
464 sub check_socket_connected
465 0 ▶{
Subroutine check_socket_connected: not called CC=3 SCAR=24.8
Pod documented
466 0 my $self = shift;
467  
468 0 ▶ unless (defined($self->{socket}) && $self->{socket}->connected)
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self->{"socket"} and $self->{"socket"}->connected) 0 0 0
Condition0%0/3
defined $self->{"socket"} and $self->{"socket"}->connected
!ll&&!rl&&r
000
MC/DC0%0/2
defined $self->{"socket"} and $self->{"socket"}->connected
defined $self->{"socket"} $self->{"socket"}->connected
Truth table0%0/3
A and B
A= defined $self->{"socket"}B= $self->{"socket"}->connected
ABresult
0X0
100
111
469 {
470 0 $self->debug(1, "SOCKET NOT CONNECTED.");
471 0 return 0;
472 }
473  
474 0 return 1;
475 }
476  
477 =head2 disconnect
478  
479 Disconnects the socket.
480 Also shuts down the TLS connection cleanly.
481  
482 =cut
483  
484 sub disconnect
485 0 ▶{
Subroutine disconnect: not called CC=2 SCAR=17.9
Pod documented
486 0 my $self = shift;
487  
488 0 $self->debug(1, "DISCONNECT.");
489  
490 0 $self->{tick_running} = 0;
491  
492 0 ▶ if ($self->{usetls})
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"usetls"}) 0 0 0
493 {
494 0 Net::SSLeay::free($self->{ssl});
495 0 delete($self->{ssl});
496 0 Net::SSLeay::free($self->{ctx});
497 0 delete($self->{ctx});
498 }
499  
500 0 close($self->{socket});
501 0 delete($self->{socket});
502  
503 0 return 1;
504 }
505  
506 =head2 ready
507  
508 Used internally.
509 Determines if the XMPP socket is ready to be used.
510 It's ready after authentication was successful, the resource is bound, and the session has started.
511  
512 =cut
513  
514 sub ready
515 0 ▶{
Subroutine ready: not called CC=3 SCAR=24.8
Pod documented
516 0 my $self = shift;
517 0 ▶ return $self->{authenticated} && $self->{resourcebound} && $self->{sessionstarted};
Condition0%0/6
$self->{'authenticated'} && $self->{'resourcebound'} && $self->{'sessionstarted'}
!ll&&!rl&&r
000
$self->{"authenticated"} and $self->{"resourcebound"}
!ll&&!rl&&r
000
MC/DC0%0/3
$self->{'authenticated'} && $self->{'resourcebound'} && $self->{'sessionstarted'}
$self->{"authenticated"} $self->{"resourcebound"} $self->{'sessionstarted'}
Truth table0%0/4
A and B && C
A= $self->{"authenticated"}B= $self->{"resourcebound"}C= $self->{'sessionstarted'}
ABCresult
0XX0
10X0
1100
1111
518 }
519  
520 =head2 use_tls
521  
522 Used internally.
523 Determines whether the socket is TLS'ified or not.
524  
525 =cut
526  
527 sub use_tls
528 0 ▶{
Subroutine use_tls: not called CC=3 SCAR=24.8
Pod documented
529 0 my $self = shift;
530 0 ▶ return (($self->{usetls} && defined($self->{ssl})) ? 1 : 0);
Branch: 1 branch
BranchTrueFalseTotal
$self->{'usetls'} && defined $self->{'ssl'} ? : 0 0 0
Condition0%0/3
$self->{"usetls"} and defined $self->{"ssl"}
!ll&&!rl&&r
000
MC/DC0%0/2
$self->{"usetls"} and defined $self->{"ssl"}
$self->{"usetls"} defined $self->{"ssl"}
Truth table0%0/3
A and B
A= $self->{"usetls"}B= defined $self->{"ssl"}
ABresult
0X0
100
111
531 }
532  
533 =head2 setup_tls
534  
535 Used internally.
536 B<Don't use it yourself.>
537 Sets up the TLS connection over the socket.
538  
539 =cut
540  
541 sub setup_tls
542 0 ▶{
Subroutine setup_tls: not called CC=5 SCAR=34.0
Pod documented
543 0 my $self = shift;
544 0 ▶ return 0 unless $self->{usetls};
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"usetls"} 0 0 0
545 0 ▶ return 0 unless $self->check_socket_connected;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->check_socket_connected 0 0 0
546  
547 0 $self->debug(2, "Using TLS, setting up.");
548  
549 0 ▶ $self->{ctx} = Net::SSLeay::CTX_new() or die "SSL ERROR: CTX_new\n";
Branch: 1 branch
BranchTrueFalseTotal
$self->{"ctx"} = Net::SSLeay::CTX_new() or die "SSL ERROR: CTX_new\n" 0 0 0
550  
551 0 Net::SSLeay::CTX_set_mode($self->{ctx}, 1 | 2);
552 0 die_if_ssl_error("SSL ERROR: CTX_set_mode");
553  
554 0 Net::SSLeay::CTX_set_options($self->{ctx}, &Net::SSLeay::OP_ALL);
555 0 die_if_ssl_error("SSL ERROR: CTX_set_options");
556  
557 0 ▶ $self->{ssl} = Net::SSLeay::new($self->{ctx}) or die "SSL ERROR: new\n";
Branch: 1 branch
BranchTrueFalseTotal
$self->{"ssl"} = Net::SSLeay::new($self->{"ctx"}) or die "SSL ERROR: new\n" 0 0 0
558  
559 0 Net::SSLeay::set_fd($self->{ssl}, fileno($self->{socket}));
560 0 die_if_ssl_error("SSL ERROR: set_fd");
561  
562 0 Net::SSLeay::connect($self->{ssl});
563 0 die_if_ssl_error("SSL ERROR: connect");
564  
565 0 return 1;
566 }
567  
568 =head2 run
569  
570 $xmpp->run(\&mycallbackfunction);
571 # .. or ..
572 $xmpp->run(sub {
573 my $xmpp = shift;
574 print "This is my callback function!\n";
575 });
576  
577 Starts the SloppyXMPP-controlled main loop.
578 If you don't want SloppyXMPP to control your loop, use C<tick> instead.
579 Runs C<tick> once, runs your callback function, and then sleeps for C<< $xmpp->{tickdelay} >> seconds.
580  
581 =cut
582  
583 sub run
584 0 ▶{
Subroutine run: not called CC=4 SCAR=30.0
Pod documented
585 0 my $self = shift;
586 0 my $callback = shift;
587  
588 0 ▶ unless (ref($callback) eq 'CODE')
Branch: 1 branch
BranchTrueFalseTotal
unless (ref $callback eq "CODE") 0 0 0
589 {
590 0 $self->debug(0, __PACKAGE__."->run requires callback and it must be a valid sub or a reference to one.");
591 0 return 0;
592 }
593  
594 0 $self->{tick_callback} = $callback;
595 0 $self->{tick_running} = 1;
596  
597 0 $self->debug(3, "BEGIN RUN LOOP");
598  
599 0 ▶ while ($self->{tick_running})
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"tick_running"}) 0 0 0
600 {
601 0 $self->debug(6, __PACKAGE__."->run TICK!");
602 0 $self->tick;
603 0 &{$self->{tick_callback}}($self);
604 0 ▶ select(undef, undef, undef, ($self->ready ? $self->{tickdelay} : 0.01));
Branch: 1 branch
BranchTrueFalseTotal
$self->ready ? : 0 0 0
605 }
606 }
607  
608 =head2 tick
609  
610 Runs the SloppyXMPP loop once.
611 Don't use this if you're using C<run>.
612  
613 =cut
614  
615 sub tick
616 0 ▶{
Subroutine tick: not called CC=6 SCAR=37.4
Pod documented
617 0 my $self = shift;
618  
619 0 ▶ $self->ping if (($self->{pingfreq} > 0) && ($self->ready) && (time() - $self->{pingtimer} > $self->{pingfreq}));
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"pingfreq"} > 0 and $self->ready and time - $self->{"pingtimer"} > $self->{"pingfreq"} 0 0 0
Condition0%0/6
$self->{"pingfreq"} > 0 and $self->ready and time - $self->{"pingtimer"} > $self->{"pingfreq"}
!ll&&!rl&&r
000
$self->{"pingfreq"} > 0 and $self->ready
!ll&&!rl&&r
000
MC/DC0%0/3
$self->{"pingfreq"} > 0 and $self->ready and time - $self->{"pingtimer"} > $self->{"pingfreq"}
$self->{"pingfreq"} > 0 $self->ready time - $self->{"pingtimer"} > $self->{"pingfreq"}
Truth table0%0/4
A and B and C
A= $self->{"pingfreq"} > 0B= $self->readyC= time - $self->{"pingtimer"} > $self->{"pingfreq"}
ABCresult
0XX0
10X0
1100
1111
620 0 $self->socket_read;
621 0 ▶ $self->process_read_buffer if length($self->{read_buffer});
Branch: 1 branch
BranchTrueFalseTotal
if length $self->{"read_buffer"} 0 0 0
622 0 ▶ $self->process_read_queue if $self->readable;
Branch: 1 branch
BranchTrueFalseTotal
if $self->readable 0 0 0
623 0 $self->socket_write;
624 }
625  
626 =head2 message
627  
628 $xmpp->message({
629 to => 'fred@fakedomain.xyz',
630 message => 'This is a message.',
631 });
632  
633 $xmpp->message({
634 to => [
635 'fred@fakedomain.xyz',
636 'jane@fakedomain.xyz',
637 ],
638 message => 'This is a message.',
639 });
640  
641 Sends a message to an XMPP user.
642 If C<to> is an arrayref, it will send to multiple parties.
643  
644 =cut
645  
646 sub message
647 0 ▶{
Subroutine message: not called CC=3 SCAR=24.8
Pod documented
648 0 my $self = shift;
649 0 my $data = shift;
650  
651 0 ▶ my @to = ((ref($data->{to}) eq 'ARRAY') ? @{$data->{to}} : ($data->{to}));
Branch: 1 branch
BranchTrueFalseTotal
ref $data->{'to'} eq 'ARRAY' ? : 0 0 0
652  
653 0 foreach my $to (@to)
654 {
655 0 $to =~ s/[<>"']//g;
656  
657 0 my $message = XMLout({
658 to => $to,
659 type => 'normal',
660 body => ["$data->{message}"],
661 }, RootName => 'message');
662  
663 0 $self->debug(5, qq(Message send to [$to] message [$message]));
664 0 $self->write($message);
665 }
666 }
667  
668 =head2 write
669  
670 Used internally.
671 B<Don't use it yourself.>
672 Writes raw data to the socket write queue.
673  
674 =cut
675  
676 sub write
677 0 ▶{
Subroutine write: not called CC=1 SCAR=6.9
Pod documented
678 0 my $self = shift;
679 0 push(@{$self->{write_queue}}, shift);
680 0 $self->socket_write; # force a write, if it can write.
681 }
682  
683 =head2 read
684  
685 Used internally.
686 B<Don't use it yourself.>
687 Reads data from the read queue.
688 Used by the event manager.
689  
690 =cut
691  
692 sub read
693 0 ▶{
Subroutine read: not called CC=1 SCAR=6.9
Pod documented
694 0 my $self = shift;
695 0 shift(@{$self->{read_queue}});
696 }
697  
698 =head2 unread
699  
700 Used internally.
701 B<Don't use it yourself.>
702 If C<read> was used, but the data can't be used, put it back in the queue.
703  
704 =cut
705  
706 sub unread
707 0 ▶{
Subroutine unread: not called CC=1 SCAR=6.9
Pod documented
708 0 my $self = shift;
709 0 unshift(@{$self->{read_queue}}, @_);
710 }
711  
712 =head2 readable
713  
714 Used internally.
715 B<Don't use it yourself.>
716 Determines if there is any data to be read in the read queue.
717  
718 =cut
719  
720 sub readable
721 0 ▶{
Subroutine readable: not called CC=2 SCAR=17.9
Pod documented
722 0 my $self = shift;
723 0 ▶ return (scalar(@{$self->{read_queue}}) ? 1 : 0);
Branch: 1 branch
BranchTrueFalseTotal
scalar @{$self->{'read_queue'};} ? : 0 0 0
724 }
725  
726 =head2 socket_write
727  
728 Used internally.
729 B<Don't use it yourself.>
730 Writes data from the socket write queue to the socket.
731  
732 =cut
733  
734 sub socket_write
735 0 ▶{
Subroutine socket_write: not called CC=8 SCAR=42.8
Pod documented
736 0 my $self = shift;
737 0 ▶ return 0 unless $self->check_socket_connected;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->check_socket_connected 0 0 0
738  
739 0 $self->debug(6, "SOCKET_WRITE");
740  
741 0 my $total_written_len = 0;
742 0 my $start_pos = 0;
743  
744 0 ▶ while (my $data = shift(@{$self->{write_queue}}))
Branch: 1 branch
BranchTrueFalseTotal
if (my $data = shift @{$$self{"write_queue"};}) 0 0 0
745 {
746 0 $data = encode_utf8($data);
747  
748 0 $self->debug(4, "SOCKET_WRITE-1: [$data]");
749  
750 0 ▶ while ($data)
Branch: 1 branch
BranchTrueFalseTotal
if ($data) 0 0 0
751 {
752 0 ▶ my $data_to_write = (($start_pos <= length($data)) ? substr($data, $start_pos, $self->{socket_write_len}) : '');
Branch: 1 branch
BranchTrueFalseTotal
$start_pos <= length $data ? : 0 0 0
753 0 my $data_to_write_len = length($data_to_write);
754 0 ▶ last unless $data_to_write_len;
Branch: 1 branch
BranchTrueFalseTotal
unless $data_to_write_len 0 0 0
755  
756 0 $self->debug(3, "SOCKET_WRITE-CHUNK: [$data_to_write_len] [$data_to_write]");
757  
758 0 my $data_written_len = 0;
759  
760 0 ▶ if ($self->use_tls)
Branch: 1 branch
BranchTrueFalseTotal
if ($self->use_tls) { } 0 0 0
761 {
762 0 $self->debug(3, "SOCKET_WRITE with TLS");
763 0 $data_written_len = Net::SSLeay::write($self->{ssl}, $data_to_write);
764 }
765 else
766 {
767 0 $self->debug(3, "SOCKET_WRITE no TLS");
768 0 $data_written_len = syswrite($self->{socket}, $data_to_write);
769 }
770  
771 0 ▶ if ($data_written_len > 0)
Branch: 1 branch
BranchTrueFalseTotal
if ($data_written_len > 0) { } 0 0 0
772 {
773 0 $start_pos += $data_written_len;
774 0 $total_written_len += $data_written_len;
775 }
776 else
777 {
778 0 unshift(@{$self->{write_queue}}, $data);
779 0 $self->debug(2, "SOCKET_WRITE ERROR: Didn't write. [$data_to_write_len] [$data_written_len] [$!]");
780 0 return $total_written_len;
781 }
782 }
783 }
784  
785 0 return $total_written_len;
786 }
787  
788 =head2 socket_read
789  
790 Used internally.
791 B<Don't use it yourself.>
792 Reads data from the socket and pushes it into the socket read buffer to be processed by C<process_read_buffer>.
793  
794 =cut
795  
796 sub socket_read
797 0 ▶{
Subroutine socket_read: not called CC=6 SCAR=37.4
Pod documented
798 0 my $self = shift;
799 0 ▶ return 0 unless $self->check_socket_connected;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->check_socket_connected 0 0 0
800  
801 0 $self->debug(6, "SOCKET_READ");
802  
803 0 my $total_read_len = 0;
804  
805 0 while (1)
806 {
807 0 my $data;
808 0 my $data_read_len = 0;
809  
810 0 ▶ if ($self->use_tls)
Branch: 1 branch
BranchTrueFalseTotal
if ($self->use_tls) { } 0 0 0
811 {
812 0 ▶ $data = Net::SSLeay::read($self->{ssl}) || '';
Condition0%0/2
Net::SSLeay::read($self->{'ssl'}) || ''
l!l
00
MC/DC0%0/1
Net::SSLeay::read($self->{'ssl'}) || ''
Net::SSLeay::read($self->{'ssl'})
Truth table0%0/2
A
A= Net::SSLeay::read($self->{'ssl'})
Aresult
11
00
813 0 ▶ $data_read_len = length($data) if defined($data);
Branch: 1 branch
BranchTrueFalseTotal
if defined $data 0 0 0
814 }
815 else
816 {
817 0 $data_read_len = sysread($self->{socket}, $data, $self->{socket_read_len});
818 }
819  
820 0 ▶ last unless $data_read_len;
Branch: 1 branch
BranchTrueFalseTotal
unless $data_read_len 0 0 0
821  
822 0 $data = decode_utf8($data);
823 0 $self->debug(3, "SOCKET_READ: [$data]");
824 0 $self->{read_buffer} .= $data;
825 0 $total_read_len += $data_read_len;
826 }
827  
828 0 return $total_read_len;
829 }
830  
831 =head2 process_read_buffer
832  
833 Used internally.
834 B<Don't use it yourself.>
835 Processes data in the socket read buffer and pushes it into the read queue to be processed by C<process_read_queue>.
836  
837 =cut
838  
839 sub process_read_buffer
840 0 ▶{
Subroutine process_read_buffer: not called CC=3 SCAR=24.8
Pod documented
841 0 my $self = shift;
842  
843 0 ▶ return 0 unless $self->{read_buffer};
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"read_buffer"} 0 0 0
844  
845 0 $self->debug(4, "PROCESS_READ_BUFFER");
846  
847 0 $self->debug(3, "PROCESS_READ_BUFFER-1: [$self->{read_buffer}]");
848 0 $self->{read_buffer} =~ s#(<\?.*?\?>)##;
849 0 $self->{read_buffer} =~ s#(</?)stream:#$1#g;
850 0 $self->{read_buffer} =~ s#xmlns:stream=#xmlns-stream=#g;
851 0 $self->{read_buffer} =~ s#:stream=#=#g;
852 0 $self->{read_buffer} =~ s#</?stream\b[^>]*?>##g;
853 0 $self->debug(3, "PROCESS_READ_BUFFER-2: [$self->{read_buffer}]");
854  
855 0 $self->{read_buffer} =~ s#^\s*(<\s*([a-z0-9\-_]+)\s*\b[^>]*?\s*)/>#$1></$2>#i; # convert self-closing first tag to empty non-self-closing tag, to prep for next regex
856  
857 0 ▶ while ($self->{read_buffer} =~ s#^\s*(<\s*([a-z0-9\-_]+)\s*\b.*?</\s*\2\s*>)##is)
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"read_buffer"} =~ s[^\s*(<\s*([a-z0-9\-_]+)\s*\b.*?</\s*\2\s*>)][]is) 0 0 0
858 {
859 0 my $section = $1;
860 0 my $opentag = $2;
861 0 $self->debug(5, "PROCESS_READ_BUFFER-OPENTAG: $opentag");
862 0 $self->debug(5, "PROCESS_READ_BUFFER-SECTION: $section");
863 0 push(@{$self->{read_queue}}, XMLin($section, KeepRoot => 1));
864 }
865 }
866  
867 =head2 process_read_queue
868  
869 Used internally.
870 B<Don't use it yourself.>
871 Handles events, errors, etc.
872  
873 =cut
874  
875 sub process_read_queue
876 0 ▶{
Subroutine process_read_queue: not called CC=36 SCAR=71.9
Pod documented
877 0 my $self = shift;
878  
879 0 $self->debug(4, "PROCESS_READ_QUEUE");
880  
881 0 ▶ while (my $data = $self->read)
Branch: 1 branch
BranchTrueFalseTotal
if (my $data = $self->read) 0 0 0
882 {
883 0 $self->debug(4, Dumper($data));
884  
885 0 ▶ if (defined($data->{features}))
Branch: 1 branch
BranchTrueFalseTotal
if (defined $data->{"features"}) 0 0 0
886 {
887 0 $self->debug(3, "PRQ: FEATURES DEFINED");
888 0 $self->{xmpp_features} = $data->{features};
889 0 $self->debug(4, Dumper($self));
890 }
891  
892 0 ▶ if (defined($data->{features}) && defined($data->{features}->{starttls}) && $self->{usetls})
Branch: 10 branches
BranchTrueFalseTotal
if (defined $data->{'features'} and defined $data->{'features'}{'starttls'} and $self->{'usetls'}) { } 0 0 0
elsif (defined $data->{'features'} and defined $data->{'features'}{'starttls'} and defined $data->{'features'}{'starttls'}{'required'} and not $self->{'usetls'}) { } 0 0 0
elsif (defined $data->{'proceed'} and defined $data->{'proceed'}{'xmlns'} and $data->{'proceed'}{'xmlns'} =~ /xmpp-tls$/i) { } 0 0 0
elsif (defined $data->{'features'} and defined $data->{'features'}{'auth'}) { } 0 0 0
elsif (defined $data->{'features'} and defined $data->{'features'}{'bind'}) { } 0 0 0
elsif (defined $data->{'iq'}) { } 0 0 0
elsif (defined $data->{'message'}) { } 0 0 0
elsif (defined $data->{'challenge'}) { } 0 0 0
elsif (defined $data->{'failure'}) { } 0 0 0
elsif (defined $data->{'success'}) { } 0 0 0
Condition0%0/6
defined $data->{"features"} and defined $data->{"features"}{"starttls"} and $self->{"usetls"}
!ll&&!rl&&r
000
defined $data->{"features"} and defined $data->{"features"}{"starttls"}
!ll&&!rl&&r
000
MC/DC0%0/3
defined $data->{"features"} and defined $data->{"features"}{"starttls"} and $self->{"usetls"}
defined $data->{"features"} defined $data->{"features"}{"starttls"} $self->{"usetls"}
Truth table0%0/4
A and B and C
A= defined $data->{"features"}B= defined $data->{"features"}{"starttls"}C= $self->{"usetls"}
ABCresult
0XX0
10X0
1100
1111
893 {
894 0 $self->debug(3, "PRQ: STARTTLS");
895 0 delete($data->{features}->{starttls}->{required});
896 0 $self->write(XMLout($data->{features}->{starttls}, RootName => 'starttls'));
897 }
898 ▶ elsif (defined($data->{features}) && defined($data->{features}->{starttls}) && defined($data->{features}->{starttls}->{required}) && !$self->{usetls})
Condition0%0/9
defined $data->{"features"} and defined $data->{"features"}{"starttls"} and defined $data->{"features"}{"starttls"}{"required"} and not $self->{"usetls"}
!ll&&!rl&&r
000
defined $data->{"features"} and defined $data->{"features"}{"starttls"} and defined $data->{"features"}{"starttls"}{"required"}
!ll&&!rl&&r
000
defined $data->{"features"} and defined $data->{"features"}{"starttls"}
!ll&&!rl&&r
000
MC/DC0%0/4
defined $data->{"features"} and defined $data->{"features"}{"starttls"} and defined $data->{"features"}{"starttls"}{"required"} and not $self->{"usetls"}
defined $data->{"features"} defined $data->{"features"}{"starttls"} defined $data->{"features"}{"starttls"}{"required"} not $self->{"usetls"}
Truth table0%0/5
A and B and C and not(D)
A= defined $data->{"features"}B= defined $data->{"features"}{"starttls"}C= defined $data->{"features"}{"starttls"}{"required"}D= not $self->{"usetls"}
ABCDresult
0XXX0
10XX0
110X0
11100
11111
899 {
900 0 $self->debug(3, "PRQ: STARTTLS IS REQUIRED");
901 0 $self->disconnect;
902 }
903 ▶ elsif (defined($data->{proceed}) && defined($data->{proceed}->{xmlns}) && $data->{proceed}->{xmlns} =~ m/xmpp-tls$/i)
Condition0%0/6
defined $data->{"proceed"} and defined $data->{"proceed"}{"xmlns"} and $data->{"proceed"}{"xmlns"} =~ /xmpp-tls$/i
!ll&&!rl&&r
000
defined $data->{"proceed"} and defined $data->{"proceed"}{"xmlns"}
!ll&&!rl&&r
000
MC/DC0%0/3
defined $data->{"proceed"} and defined $data->{"proceed"}{"xmlns"} and $data->{"proceed"}{"xmlns"} =~ /xmpp-tls$/i
defined $data->{"proceed"} defined $data->{"proceed"}{"xmlns"} $data->{"proceed"}{"xmlns"} =~ /xmpp-tls$/i
Truth table0%0/4
A and B and C
A= defined $data->{"proceed"}B= defined $data->{"proceed"}{"xmlns"}C= $data->{"proceed"}{"xmlns"} =~ /xmpp-tls$/i
ABCresult
0XX0
10X0
1100
1111
904 {
905 0 $self->debug(3, "PRQ: PROCEED WITH TLS");
906 0 ▶ if ($self->setup_tls)
Branch: 1 branch
BranchTrueFalseTotal
if ($self->setup_tls) 0 0 0
907 {
908 0 $self->debug(3, "PRQ: SETUPTLS SUCCESS");
909 0 $self->sendhandshake;
910 }
911 }
912 ▶ elsif (defined($data->{features}) && defined($data->{features}->{auth}))
Condition0%0/3
defined $data->{"features"} and defined $data->{"features"}{"auth"}
!ll&&!rl&&r
000
MC/DC0%0/2
defined $data->{"features"} and defined $data->{"features"}{"auth"}
defined $data->{"features"} defined $data->{"features"}{"auth"}
Truth table0%0/3
A and B
A= defined $data->{"features"}B= defined $data->{"features"}{"auth"}
ABresult
0X0
100
111
913 {
914 0 $self->debug(3, "PRQ: AUTHENTICATION WILL COMMENCE");
915 0 $self->authenticate;
916 }
917 ▶ elsif (defined($data->{features}) && defined($data->{features}->{bind}))
Condition0%0/3
defined $data->{"features"} and defined $data->{"features"}{"bind"}
!ll&&!rl&&r
000
MC/DC0%0/2
defined $data->{"features"} and defined $data->{"features"}{"bind"}
defined $data->{"features"} defined $data->{"features"}{"bind"}
Truth table0%0/3
A and B
A= defined $data->{"features"}B= defined $data->{"features"}{"bind"}
ABresult
0X0
100
111
918 {
919 0 $self->debug(3, "PRQ: RESOURCE BIND WILL COMMENCE");
920 0 $self->bindresource;
921 }
922 elsif (defined($data->{iq}))
923 {
924 0 $self->debug(3, "PRQ: IQ RECEIVED");
925 0 ▶ if (defined($data->{iq}->{bind}))
Branch: 4 branches
BranchTrueFalseTotal
if (defined $data->{'iq'}{'bind'}) { } 0 0 0
elsif (defined $data->{'iq'}{'session'}) { } 0 0 0
elsif (defined $data->{'iq'}{'query'}{'xmlns'} and $data->{'iq'}{'query'}{'xmlns'} eq 'jabber:iq:roster') { } 0 0 0
elsif (defined $data->{'iq'}{'ping'}) { } 0 0 0
926 {
927 0 $self->debug(3, "PRQ: BIND IQ RECEIVED");
928 0 ▶ if ($data->{iq}->{type} eq 'error')
Branch: 1 branch
BranchTrueFalseTotal
if ($data->{'iq'}{'type'} eq 'error') { } 0 0 0
929 {
930 0 $self->debug(3, "PRQ: BIND IQ ERROR");
931 0 $self->debug(3, Dumper($data));
932 }
933 else
934 {
935 0 $self->{resourcebound} = 1;
936 0 $self->{jid} = $data->{iq}->{bind}->{jid};
937 0 $self->debug(3, Dumper($self->{xmpp_features}));
938 0 ▶ if (defined($self->{xmpp_features}->{session}))
Branch: 1 branch
BranchTrueFalseTotal
if (defined $self->{"xmpp_features"}{"session"}) 0 0 0
939 {
940 0 $self->startsession;
941 }
942 }
943 }
944 elsif (defined($data->{iq}->{session}))
945 {
946 0 $self->debug(3, "PRQ: SESSION IQ RECEIVED");
947 0 ▶ if ($data->{iq}->{type} eq 'error')
Branch: 1 branch
BranchTrueFalseTotal
if ($data->{'iq'}{'type'} eq 'error') { } 0 0 0
948 {
949 0 $self->debug(3, "PRQ: SESSION IQ ERROR");
950 0 $self->debug(3, Dumper($data));
951 }
952 else
953 {
954 0 $self->{sessionstarted} = 1;
955 0 $self->rosterfetch;
956 }
957 }
958 ▶ elsif (defined($data->{iq}->{query}->{xmlns}) && $data->{iq}->{query}->{xmlns} eq 'jabber:iq:roster')
Condition0%0/3
defined $data->{"iq"}{"query"}{"xmlns"} and $data->{"iq"}{"query"}{"xmlns"} eq "jabber:iq:roster"
!ll&&!rl&&r
000
MC/DC0%0/2
defined $data->{"iq"}{"query"}{"xmlns"} and $data->{"iq"}{"query"}{"xmlns"} eq "jabber:iq:roster"
defined $data->{"iq"}{"query"}{"xmlns"} $data->{"iq"}{"query"}{"xmlns"} eq "jabber:iq:roster"
Truth table0%0/3
A and B
A= defined $data->{"iq"}{"query"}{"xmlns"}B= $data->{"iq"}{"query"}{"xmlns"} eq "jabber:iq:roster"
ABresult
0X0
100
111
959 {
960 0 $self->debug(3, "PRQ: ROSTER RECEIVED");
961 0 $self->presence($self->{initialpresence}, $self->{initialstatus});
962 0 $self->rosterreceived($data->{iq}->{query});
963 }
964 elsif (defined($data->{iq}->{ping}))
965 {
966 0 $self->debug(3, "PRQ: PING IQ RECEIVED");
967 0 $self->pong($data->{iq});
968 }
969 }
970 elsif (defined($data->{message}))
971 {
972 0 $self->debug(3, "PRQ: MESSAGE RECEIVED");
973 0 ▶ if (defined($data->{message}->{composing}))
Branch: 4 branches
BranchTrueFalseTotal
if (defined $data->{'message'}{'composing'}) { } 0 0 0
elsif (defined $data->{'message'}{'body'}) { } 0 0 0
elsif (defined $data->{'message'}{'paused'}) { } 0 0 0
elsif (defined $data->{'message'}{'active'}) { } 0 0 0
974 {
975 0 $self->debug(3, "PRQ: MESSAGE IS BEING COMPOSED");
976 0 $self->messagecomposingstarted($data->{message});
977 }
978 elsif (defined($data->{message}->{body}))
979 {
980 0 my $body = $data->{message}->{body};
981 0 $self->debug(3, "PRQ: MESSAGE BODY RECEIVED");
982 0 $self->debug(3, "MESSAGE: $body");
983 0 $self->messagereceived($data->{message});
984 }
985 elsif (defined($data->{message}->{paused}))
986 {
987 0 $self->debug(3, "PRQ: MESSAGE IS BEING COMPOSED HAS PAUSED");
988 0 $self->messagecomposingpaused($data->{message});
989 }
990 elsif (defined($data->{message}->{active}))
991 {
992 0 $self->debug(3, "PRQ: MESSAGE IS BEING COMPOSED HAS ENDED");
993 0 $self->messagecomposingended($data->{message});
994 }
995 }
996 elsif (defined($data->{challenge}))
997 {
998 0 $self->debug(3, "PRQ: SASL CHALLENGE RECEIVED");
999 0 $self->saslchallenge($data);
1000 }
1001 elsif (defined($data->{failure}))
1002 {
1003 0 $self->debug(3, "PRQ: FAILURE DETECTED");
1004 0 ▶ if (defined($data->{failure}->{'not-authorized'}))
Branch: 1 branch
BranchTrueFalseTotal
if (defined $data->{"failure"}{"not-authorized"}) 0 0 0
1005 {
1006 0 $self->debug(3, "PRQ: AUTHENTICATION FAILURE");
1007 }
1008 }
1009 elsif (defined($data->{success}))
1010 {
1011 0 $self->debug(3, "PRQ: SUCCESS DETECTED");
1012 0 $self->saslsuccess($data);
1013 }
1014 }
1015 }
1016  
1017 =head2 authenticated
1018  
1019 Used internally.
1020 Returns true if this connection has been authenticated successfully.
1021  
1022 =cut
1023  
1024 sub authenticated
1025 0 ▶{
Subroutine authenticated: not called CC=1 SCAR=6.9
Pod documented
1026 0 my $self = shift;
1027 0 return $self->{authenticated};
1028 }
1029  
1030 =head2 authenticate
1031  
1032 Used internally.
1033 B<Don't use it yourself.>
1034 Begins the authentication process.
1035  
1036 =cut
1037  
1038 sub authenticate
1039 0 ▶{
Subroutine authenticate: not called CC=8 SCAR=42.8
Pod documented
1040 0 my $self = shift;
1041 0 ▶ return 0 unless $self->check_socket_connected;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->check_socket_connected 0 0 0
1042 0 ▶ return 0 if ($self->{usetls} && !$self->use_tls); # want TLS, but not ready
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"usetls"} and not $self->use_tls 0 0 0
Condition0%0/3
$self->{"usetls"} and not $self->use_tls
!ll&&!rl&&r
000
MC/DC0%0/2
$self->{"usetls"} and not $self->use_tls
$self->{"usetls"} not $self->use_tls
Truth table0%0/3
A and not(B)
A= $self->{"usetls"}B= not $self->use_tls
ABresult
0X0
100
111
1043 0 ▶ return 0 unless (defined($self->{xmpp_features}) && defined($self->{xmpp_features}->{auth}));
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->{"xmpp_features"} and defined $self->{"xmpp_features"}{"auth"} 0 0 0
Condition0%0/3
defined $self->{"xmpp_features"} and defined $self->{"xmpp_features"}{"auth"}
!ll&&!rl&&r
000
MC/DC0%0/2
defined $self->{"xmpp_features"} and defined $self->{"xmpp_features"}{"auth"}
defined $self->{"xmpp_features"} defined $self->{"xmpp_features"}{"auth"}
Truth table0%0/3
A and B
A= defined $self->{"xmpp_features"}B= defined $self->{"xmpp_features"}{"auth"}
ABresult
0X0
100
111
1044  
1045 0 $self->debug(2, "Authenticating with XMPP");
1046  
1047 0 ▶ if ($self->{usesasl})
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"usesasl"}) 0 0 0
1048 {
1049 0 my $xmlns = $self->{xmpp_features}->{mechanisms}->{xmlns};
1050 0 my $mechanisms = $self->{xmpp_features}->{mechanisms}->{mechanism};
1051 0 ▶ my @mechanisms = (ref($mechanisms) eq 'ARRAY' ? @{$mechanisms} : ($mechanisms));
Branch: 1 branch
BranchTrueFalseTotal
ref $mechanisms eq 'ARRAY' ? : 0 0 0
1052 my $sasl = Authen::SASL->new(
1053 mechanism => join(' ', @mechanisms),
1054 callback => {
1055 user => $self->{username},
1056 pass => $self->{password},
1057 },
1058 0 );
1059 0 $self->debug(5, Dumper($sasl));
1060 0 $self->{sasl} = $sasl->client_new('xmpp', $self->{domain});
1061 0 my $mechanism = $self->{sasl}->mechanism;
1062 0 my $response = MIME::Base64::encode_base64($self->{sasl}->client_start, '');
1063 0 $self->write(qq(<auth xmlns="$xmlns" mechanism="$mechanism"/>));
1064 }
1065 }
1066  
1067 =head2 saslchallenge
1068  
1069 Used internally.
1070 B<Don't use it yourself.>
1071 Handles the SASL challenge.
1072  
1073 =cut
1074  
1075 sub saslchallenge
1076 0 ▶{
Subroutine saslchallenge: not called CC=2 SCAR=17.9
Pod documented
1077 0 my $self = shift;
1078 0 my $data = shift;
1079 0 my $challenge = MIME::Base64::decode_base64($data->{challenge}->{content});
1080  
1081 0 $self->debug(2, "SASLCHALLENGE!");
1082 0 $self->debug(3, Dumper($challenge));
1083  
1084 0 $self->debug(1, "SENDING RESPONSE TO SASLCHALLENGE");
1085 0 my $xmlns = $data->{challenge}->{xmlns};
1086 0 my $response = $self->{sasl}->client_step($challenge);
1087 0 ▶ unless ($response)
Branch: 1 branch
BranchTrueFalseTotal
unless ($response) 0 0 0
1088 {
1089 0 $self->debug(1, "SASL ERROR for $challenge");
1090 0 return 0;
1091 }
1092 0 $response = MIME::Base64::encode_base64($response);
1093 0 $self->write(qq(<response xmlns="$xmlns">$response</response>));
1094 }
1095  
1096 =head2 saslsuccess
1097  
1098 Used internally.
1099 B<Don't use it yourself.>
1100 Handles SASL challenge success.
1101  
1102 =cut
1103  
1104 sub saslsuccess
1105 0 ▶{
Subroutine saslsuccess: not called CC=1 SCAR=6.9
Pod documented
1106 0 my $self = shift;
1107 0 my $data = shift;
1108 0 my $success = MIME::Base64::decode_base64($data->{success}->{content});
1109  
1110 0 $self->debug(1, "SUCCESSFUL SASLCHALLENGE");
1111 0 $self->debug(3, Dumper($success));
1112  
1113 0 $self->{authenticated} = 1;
1114  
1115 0 $self->sendhandshake;
1116 }
1117  
1118 =head2 bindresource
1119  
1120 Used internally.
1121 B<Don't use it yourself.>
1122 Binds this connection to a specific resource.
1123  
1124 =cut
1125  
1126 sub bindresource
1127 0 ▶{
Subroutine bindresource: not called CC=1 SCAR=6.9
Pod documented
1128 0 my $self = shift;
1129  
1130 0 $self->debug(1, "RESOURCE BIND");
1131  
1132 0 my $xmlns = $self->{xmpp_features}->{bind}->{xmlns};
1133 0 $self->write(qq(<iq type="set" id="bind_2"><bind xmlns="$xmlns"><resource>$self->{resource}</resource></bind></iq>));
1134 }
1135  
1136 =head2 startsession
1137  
1138 Used internally.
1139 B<Don't use it yourself.>
1140 Starts the XMPP session.
1141  
1142 =cut
1143  
1144 sub startsession
1145 0 ▶{
Subroutine startsession: not called CC=1 SCAR=6.9
Pod documented
1146 0 my $self = shift;
1147  
1148 0 $self->debug(1, "SESSION START");
1149  
1150 0 my $xmlns = $self->{xmpp_features}->{session}->{xmlns};
1151 0 $self->write(qq(<iq to="$self->{domain}" type="set" id="sess_1"><session xmlns="$xmlns" /></iq>));
1152 }
1153  
1154 =head2 presence
1155  
1156 $xmpp->presence('available', 'Playing music and eating chips.');
1157  
1158 Sets your presence and status.
1159  
1160 =cut
1161  
1162 sub presence
1163 0 ▶{
Subroutine presence: not called CC=4 SCAR=30.0
Pod documented
1164 0 my $self = shift;
1165 0 ▶ my $presence = shift || 'available';
Condition0%0/2
shift() || 'available'
l!l
00
MC/DC0%0/1
shift() || 'available'
shift()
Truth table0%0/2
A
A= shift()
Aresult
11
00
1166 0 ▶ my $status = shift || '';
Condition0%0/2
shift() || ''
l!l
00
MC/DC0%0/1
shift() || ''
shift()
Truth table0%0/2
A
A= shift()
Aresult
11
00
1167 0 ▶ return 0 unless $self->ready;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->ready 0 0 0
1168  
1169 0 $self->debug(1, "SET PRESENCE -> $presence -> $status");
1170 0 $self->write(qq(<presence xml:lang="en"><show>$presence</show><status>$status</status></presence>));
1171 0 return 1;
1172 }
1173  
1174 =head2 messagecomposingstarted
1175  
1176 Used internally.
1177 B<Don't use it yourself.>
1178 Event handler uses this function to handle the C<messagecomposingstarted> event.
1179 This happens when some user starts typing a message to you.
1180 Not all XMPP clients send this notification.
1181  
1182 =cut
1183  
1184 sub messagecomposingstarted
1185 0 ▶{
Subroutine messagecomposingstarted: not called CC=1 SCAR=6.9
Pod documented
1186 0 my $self = shift;
1187 0 my $data = shift;
1188  
1189 0 $self->debug(1, "A MESSAGE IS BEING COMPOSED TO YOU FROM [$data->{from}]");
1190 }
1191  
1192 =head2 messagecomposingpaused
1193  
1194 Used internally.
1195 B<Don't use it yourself.>
1196 Event handler uses this function to handle the C<messagecomposingpaused> event.
1197 This happens when the person typing the message stopped typing (but didn't erase
1198 their message, send the message, or close the message window).
1199  
1200 =cut
1201  
1202 sub messagecomposingpaused
1203 0 ▶{
Subroutine messagecomposingpaused: not called CC=1 SCAR=6.9
Pod documented
1204 0 my $self = shift;
1205 0 my $data = shift;
1206  
1207 0 $self->debug(1, "A MESSAGE BEING COMPOSED TO YOU FROM [$data->{from}] HAS PAUSED.");
1208 }
1209  
1210 =head2 messagecomposingended
1211  
1212 Used internally.
1213 B<Don't use it yourself.>
1214 Event handler uses this function to handle the C<messagecomposingended> event.
1215 This happens when the person typing the message quit their message (erased
1216 their message, sent the message, or closed the message window).
1217  
1218 =cut
1219  
1220 sub messagecomposingended
1221 0 ▶{
Subroutine messagecomposingended: not called CC=1 SCAR=6.9
Pod documented
1222 0 my $self = shift;
1223 0 my $data = shift;
1224  
1225 0 $self->debug(1, "A MESSAGE BEING COMPOSED TO YOU FROM [$data->{from}] HAS ENDED.");
1226 }
1227  
1228 =head2 messagereceived
1229  
1230 Used internally.
1231 B<Don't use it yourself.>
1232 Event handler uses this function to handle the C<messagereceived> event.
1233 This happens when a message is received from another XMPP user.
1234  
1235 =cut
1236  
1237 sub messagereceived
1238 0 ▶{
Subroutine messagereceived: not called CC=1 SCAR=6.9
Pod documented
1239 0 my $self = shift;
1240 0 my $data = shift;
1241  
1242 0 $self->debug(1, "MESSAGE RECEIVED FROM [$data->{from}]");
1243  
1244 0 $self->debug(2, <<XYZ);
1245 ---------------
1246 To: $data->{to}
1247 From: $data->{from}
1248 Body: $data->{body}
1249 ---------------
1250 XYZ
1251  
1252 0 &{$self->{message_callback}}($self, $data);
1253 }
1254  
1255 =head2 roster
1256  
1257 my $roster = $xmpp->roster;
1258  
1259 Returns an arrayref that contains the roster.
1260  
1261 =cut
1262  
1263 sub roster
1264 0 ▶{
Subroutine roster: not called CC=1 SCAR=6.9
Pod documented
1265 0 my $self = shift;
1266 0 return $self->{roster};
1267 }
1268  
1269 =head2 rosterfetch
1270  
1271 Used internally.
1272 B<Don't use it yourself.>
1273 Requests the roster from the XMPP server.
1274 Only has to happen once at connection time.
1275  
1276 =cut
1277  
1278 sub rosterfetch
1279 0 ▶{
Subroutine rosterfetch: not called CC=1 SCAR=6.9
Pod documented
1280 0 my $self = shift;
1281  
1282 0 $self->debug(1, "GETTING ROSTER");
1283  
1284 0 $self->write(qq(<iq from="$self->{jid}" type="get" id="roster_1"><query xmlns="jabber:iq:roster" /></iq>));
1285 }
1286  
1287 =head2 rosterreceived
1288  
1289 Used internally.
1290 B<Don't use it yourself.>
1291 The roster arrived from the XMPP server.
1292 This populates the proper variable that contains the roster arrayref.
1293 Access this data via C<roster> (see above).
1294  
1295 =cut
1296  
1297 sub rosterreceived
1298 0 ▶{
Subroutine rosterreceived: not called CC=2 SCAR=17.9
Pod documented
1299 0 my $self = shift;
1300 0 my $roster = shift;
1301  
1302 0 $self->debug(1, "RECEIVED ROSTER");
1303  
1304 0 ▶ my @contacts = (ref($roster->{item}) eq 'ARRAY' ? @{$roster->{item}} : ($roster->{item}));
Branch: 1 branch
BranchTrueFalseTotal
ref $roster->{'item'} eq 'ARRAY' ? : 0 0 0
1305  
1306 0 $self->{roster} = \@contacts;
1307  
1308 0 $self->debug(3, Dumper($self->{roster}));
1309 }
1310  
1311 =head2 ping
1312  
1313 Used internally.
1314 B<Don't use it yourself.>
1315 Sends a ping to the server.
1316  
1317 =cut
1318  
1319 sub ping
1320 0 ▶{
Subroutine ping: not called CC=1 SCAR=6.9
Pod documented
1321 0 my $self = shift;
1322 0 my $id = 'ping'.int(rand() * 100000);
1323 0 $self->write(qq(<iq from='$self->{jid}' to='$self->{domain}' id='$id' type='get'><ping xmlns='urn:xmpp:ping'/></iq>));
1324 0 $self->{pingtimer} = time();
1325 }
1326  
1327 =head2 pong
1328  
1329 Used internally.
1330 B<Don't use it yourself.>
1331 Sends a pong (ping response) to the server.
1332  
1333 =cut
1334  
1335 sub pong
1336 0 ▶{
Subroutine pong: not called CC=1 SCAR=6.9
Pod documented
1337 0 my $self = shift;
1338 0 my $data = shift;
1339 0 my $from = $data->{from};
1340 0 my $id = $data->{id};
1341 0 $self->write(qq(<iq from='$self->{jid}' to='$from' id='$id' type='result'/>));
1342 0 $self->{pingtimer} = time();
1343 }
1344  
1345 =head1 TODO
1346  
1347 =over
1348  
1349 =item *
1350  
1351 Event callbacks. There aren't any. They are planned and should be reasonably easy to setup.
1352 This module isn't all that useful without them.
1353  
1354 =item *
1355  
1356 Test on more XMPP servers. This has only been tested on the Openfire XMPP Server, version 3.6.2.
1357  
1358 =item *
1359  
1360 Make sure it works on Google's XMPP servers. Right now, it doesn't.
1361  
1362 =back
1363  
1364 =head1 BUGS
1365  
1366 Find bugs? Of course you will. Report them on the CPAN bug tracker. Don't email me directly about bugs.
1367 If it works for you, I'd love to hear about it. Find my email address in my CPAN profile (C<wilsond>).
1368 Make sure to put "C<Net::SloppyXMPP Feedback>" in the subject line or I might ignore it completely.
1369 Please don't send HTML email if at all possible. I greatly prefer plaintext email.
1370  
1371 If you have a patch for this module, post it on the CPAN bug tracker. If it fits the goal of this module,
1372 I'll be very happy to merge it in. If it doesn't fit the goal, I won't, even if you think it makes sense.
1373  
1374 =over
1375  
1376 =item *
1377  
1378 This is version 0.04 of a module called SloppyXMPP. If you don't hit any bugs, you might want to try
1379 your luck at the lottery today.
1380  
1381 =item *
1382  
1383 Doesn't work with Google's XMPP server right now. I plan to make it work.
1384  
1385 =back
1386  
1387 =head1 COPYRIGHT/LICENSE
1388  
1389 Copyright 2009 Megagram. You can use any one of these licenses: Perl Artistic, GPL (version >= 2), BSD.
1390  
1391 =head2 Perl Artistic License
1392  
1393 Read it at L<http://dev.perl.org/licenses/artistic.html>.
1394 This is the license we prefer.
1395  
1396 =head2 GNU General Public License (GPL) Version 2
1397  
1398 This program is free software; you can redistribute it and/or
1399 modify it under the terms of the GNU General Public License
1400 as published by the Free Software Foundation; either version 2
1401 of the License, or (at your option) any later version.
1402  
1403 This program is distributed in the hope that it will be useful,
1404 but WITHOUT ANY WARRANTY; without even the implied warranty of
1405 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1406 GNU General Public License for more details.
1407  
1408 You should have received a copy of the GNU General Public License
1409 along with this program. If not, see http://www.gnu.org/licenses/
1410  
1411 See the full license at L<http://www.gnu.org/licenses/>.
1412  
1413 =head2 GNU General Public License (GPL) Version 3
1414  
1415 This program is free software: you can redistribute it and/or modify
1416 it under the terms of the GNU General Public License as published by
1417 the Free Software Foundation, either version 3 of the License, or
1418 (at your option) any later version.
1419  
1420 This program is distributed in the hope that it will be useful,
1421 but WITHOUT ANY WARRANTY; without even the implied warranty of
1422 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1423 GNU General Public License for more details.
1424  
1425 You should have received a copy of the GNU General Public License
1426 along with this program. If not, see http://www.gnu.org/licenses/
1427  
1428 See the full license at L<http://www.gnu.org/licenses/>.
1429  
1430 =head2 BSD License
1431  
1432 Copyright (c) 2009 Megagram.
1433 All rights reserved.
1434  
1435 Redistribution and use in source and binary forms, with or without modification, are permitted
1436 provided that the following conditions are met:
1437  
1438 * Redistributions of source code must retain the above copyright notice, this list of conditions
1439 and the following disclaimer.
1440 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions
1441 and the following disclaimer in the documentation and/or other materials provided with the
1442 distribution.
1443 * Neither the name of Megagram nor the names of its contributors may be used to endorse
1444 or promote products derived from this software without specific prior written permission.
1445  
1446 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
1447 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
1448 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
1449 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1450 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1451 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
1452 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
1453 IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1454  
1455 =cut
↑ Summary