| 1 |
package Net::XMPP2::Error; |
| 2 |
use strict; |
| 3 |
use Net::XMPP2::Util qw/stringprep_jid prep_bare_jid/; |
| 4 |
use Net::XMPP2::Error; |
| 5 |
|
| 6 |
=head1 NAME |
| 7 |
|
| 8 |
Net::XMPP2::Error - An error class hierarchy for error reporting |
| 9 |
|
| 10 |
=head1 SYNOPSIS |
| 11 |
|
| 12 |
die $error->string; |
| 13 |
|
| 14 |
=head1 DESCRIPTION |
| 15 |
|
| 16 |
This module is a helper class for abstracting any kind |
| 17 |
of error that occurs in Net::XMPP2. |
| 18 |
|
| 19 |
You receive instances of these objects by various events. |
| 20 |
|
| 21 |
=cut |
| 22 |
|
| 23 |
sub new { |
| 24 |
my $this = shift; |
| 25 |
my $class = ref($this) || $this; |
| 26 |
my $self = bless { @_ }, $class; |
| 27 |
$self->init; |
| 28 |
$self |
| 29 |
} |
| 30 |
|
| 31 |
sub init { } |
| 32 |
|
| 33 |
=head1 SUPER CLASS |
| 34 |
|
| 35 |
Net::XMPP2::Error - The super class of all errors |
| 36 |
|
| 37 |
=head2 METHODS |
| 38 |
|
| 39 |
These methods are implemented by all subclasses. |
| 40 |
|
| 41 |
=head3 string () |
| 42 |
|
| 43 |
Returns a humand readable string for this error. |
| 44 |
|
| 45 |
=cut |
| 46 |
|
| 47 |
sub string { |
| 48 |
my ($self) = @_; |
| 49 |
$self->{text} |
| 50 |
} |
| 51 |
|
| 52 |
package Net::XMPP2::Error::Stanza; |
| 53 |
our @ISA = qw/Net::XMPP2::Error/; |
| 54 |
|
| 55 |
=head1 SUBCLASS |
| 56 |
|
| 57 |
Net::XMPP2::Error::Stanza - Stanza errors |
| 58 |
|
| 59 |
=cut |
| 60 |
|
| 61 |
sub init { |
| 62 |
my ($self) = @_; |
| 63 |
my $node = $self->xml_node; |
| 64 |
|
| 65 |
unless (defined $node) { |
| 66 |
$self->{error_cond} = 'client-timeout'; |
| 67 |
$self->{error_type} = 'cancel'; |
| 68 |
return; |
| 69 |
} |
| 70 |
|
| 71 |
my @error; |
| 72 |
my ($err) = $node->find_all ([qw/client error/]); |
| 73 |
|
| 74 |
unless ($err) { |
| 75 |
warn "No error element found in error stanza!"; |
| 76 |
$self->{text} = "Unknown Stanza error"; |
| 77 |
return |
| 78 |
} |
| 79 |
|
| 80 |
$self->{error_type} = $err->attr ('type'); |
| 81 |
$self->{error_code} = $err->attr ('code'); |
| 82 |
|
| 83 |
if (my ($txt) = $err->find_all ([qw/stanzas text/])) { |
| 84 |
$self->{error_text} = $txt->text; |
| 85 |
} |
| 86 |
|
| 87 |
for my $er ( |
| 88 |
qw/bad-request conflict feature-not-implemented forbidden |
| 89 |
gone internal-server-error item-not-found jid-malformed |
| 90 |
not-acceptable not-allowed not-authorized payment-required |
| 91 |
recipient-unavailable redirect registration-required |
| 92 |
remote-server-not-found remote-server-timeout resource-constraint |
| 93 |
service-unavailable subscription-required undefined-condition |
| 94 |
unexpected-request/) |
| 95 |
{ |
| 96 |
if (my ($el) = $err->find_all ([stanzas => $er])) { |
| 97 |
$self->{error_cond} = $er; |
| 98 |
$self->{error_cond_node} = $el; |
| 99 |
last; |
| 100 |
} |
| 101 |
} |
| 102 |
} |
| 103 |
|
| 104 |
=head2 METHODS |
| 105 |
|
| 106 |
=head3 xml_node () |
| 107 |
|
| 108 |
Returns the L<Net::XMPP2::Node> object for this Stanza error. |
| 109 |
This method returns undef if the Stanza timeouted. |
| 110 |
|
| 111 |
In the case of a timeout the C<condition> method returns C<client-timeout>, |
| 112 |
C<type> returns 'cancel' and C<code> undef. |
| 113 |
|
| 114 |
=cut |
| 115 |
|
| 116 |
sub xml_node { |
| 117 |
$_[0]->{node} |
| 118 |
} |
| 119 |
|
| 120 |
=head3 |
| 121 |
|
| 122 |
=head3 type () |
| 123 |
|
| 124 |
This method returns one of: |
| 125 |
|
| 126 |
'cancel', 'continue', 'modify', 'auth' and 'wait' |
| 127 |
|
| 128 |
=cut |
| 129 |
|
| 130 |
sub type { $_[0]->{error_type} } |
| 131 |
|
| 132 |
=head3 code () |
| 133 |
|
| 134 |
This method returns the error code if one was found. |
| 135 |
|
| 136 |
=cut |
| 137 |
|
| 138 |
sub code { $_[0]->{error_code} } |
| 139 |
|
| 140 |
=head3 condition () |
| 141 |
|
| 142 |
Returns the error condition string if one was found when receiving the Stanza error. |
| 143 |
It can be undef or one of: |
| 144 |
|
| 145 |
bad-request |
| 146 |
conflict |
| 147 |
feature-not-implemented |
| 148 |
forbidden |
| 149 |
gone |
| 150 |
internal-server-error |
| 151 |
item-not-found |
| 152 |
jid-malformed |
| 153 |
not-acceptable |
| 154 |
not-allowed |
| 155 |
not-authorized |
| 156 |
payment-required |
| 157 |
recipient-unavailable |
| 158 |
redirect |
| 159 |
registration-required |
| 160 |
remote-server-not-found |
| 161 |
remote-server-timeout |
| 162 |
resource-constraint |
| 163 |
service-unavailable |
| 164 |
subscription-required |
| 165 |
undefined-condition |
| 166 |
unexpected-request |
| 167 |
|
| 168 |
|
| 169 |
=cut |
| 170 |
|
| 171 |
sub condition { $_[0]->{error_cond} } |
| 172 |
|
| 173 |
=head3 condition_node () |
| 174 |
|
| 175 |
Returns the error condition node if one was found when receiving the Stanza error. |
| 176 |
This is mostly for debugging purposes. |
| 177 |
|
| 178 |
=cut |
| 179 |
|
| 180 |
sub condition_node { $_[0]->{error_cond_node} } |
| 181 |
|
| 182 |
=head3 text () |
| 183 |
|
| 184 |
The humand readable error portion. Might be undef if none was received. |
| 185 |
|
| 186 |
=cut |
| 187 |
|
| 188 |
sub text { $_[0]->{error_text} } |
| 189 |
|
| 190 |
sub string { |
| 191 |
my ($self) = @_; |
| 192 |
|
| 193 |
sprintf "stanza error: %s/%s (type %s): %s", |
| 194 |
$self->code || '', |
| 195 |
$self->condition || '', |
| 196 |
$self->type, |
| 197 |
$self->text |
| 198 |
} |
| 199 |
|
| 200 |
package Net::XMPP2::Error::Presence; |
| 201 |
our @ISA = qw/Net::XMPP2::Error::Stanza/; |
| 202 |
|
| 203 |
=head1 SUBCLASS |
| 204 |
|
| 205 |
Net::XMPP2::Error::Presence - Message errors |
| 206 |
|
| 207 |
(Subclass of L<Net::XMPP2::Error::Stanza>) |
| 208 |
|
| 209 |
=cut |
| 210 |
|
| 211 |
sub string { |
| 212 |
my ($self) = @_; |
| 213 |
|
| 214 |
sprintf "presence error: %s/%s (type %s): %s", |
| 215 |
$self->code || '', |
| 216 |
$self->condition || '', |
| 217 |
$self->type, |
| 218 |
$self->text |
| 219 |
} |
| 220 |
|
| 221 |
package Net::XMPP2::Error::Message; |
| 222 |
our @ISA = qw/Net::XMPP2::Error::Stanza/; |
| 223 |
|
| 224 |
=head1 SUBCLASS |
| 225 |
|
| 226 |
Net::XMPP2::Error::Message - Message errors |
| 227 |
|
| 228 |
(Subclass of L<Net::XMPP2::Error::Stanza>) |
| 229 |
|
| 230 |
=cut |
| 231 |
|
| 232 |
sub string { |
| 233 |
my ($self) = @_; |
| 234 |
|
| 235 |
sprintf "message error: %s/%s (type %s): %s", |
| 236 |
$self->code || '', |
| 237 |
$self->condition || '', |
| 238 |
$self->type, |
| 239 |
$self->text |
| 240 |
} |
| 241 |
|
| 242 |
package Net::XMPP2::Error::IQ; |
| 243 |
our @ISA = qw/Net::XMPP2::Error::Stanza/; |
| 244 |
|
| 245 |
=head1 SUBCLASS |
| 246 |
|
| 247 |
Net::XMPP2::Error::IQ - IQ errors |
| 248 |
|
| 249 |
(Subclass of L<Net::XMPP2::Error::Stanza>) |
| 250 |
|
| 251 |
=cut |
| 252 |
|
| 253 |
sub init { |
| 254 |
my ($self) = @_; |
| 255 |
my $node = $self->xml_node; |
| 256 |
|
| 257 |
unless (defined $node) { |
| 258 |
$self->{error_cond} = 'client-timeout'; |
| 259 |
$self->{error_type} = 'cancel'; |
| 260 |
return; |
| 261 |
} |
| 262 |
|
| 263 |
$self->SUPER::init; |
| 264 |
} |
| 265 |
|
| 266 |
=head3 condition () |
| 267 |
|
| 268 |
Same as L<Net::XMPP2::Error::Stanza> except that |
| 269 |
in case of a IQ timeout it returns: |
| 270 |
|
| 271 |
'client-timeout' |
| 272 |
|
| 273 |
=cut |
| 274 |
|
| 275 |
sub string { |
| 276 |
my ($self) = @_; |
| 277 |
|
| 278 |
sprintf "iq error: %s/%s (type %s): %s", |
| 279 |
$self->code || '', |
| 280 |
$self->condition || '', |
| 281 |
$self->type, |
| 282 |
$self->text |
| 283 |
} |
| 284 |
|
| 285 |
package Net::XMPP2::Error::Stream; |
| 286 |
our @ISA = qw/Net::XMPP2::Error/; |
| 287 |
|
| 288 |
=head1 SUBCLASS |
| 289 |
|
| 290 |
Net::XMPP2::Error::Stream - XML Stream errors |
| 291 |
|
| 292 |
=cut |
| 293 |
|
| 294 |
sub init { |
| 295 |
my ($self) = @_; |
| 296 |
my $node = $self->xml_node; |
| 297 |
|
| 298 |
my @txt = $node->find_all ([qw/streams text/]); |
| 299 |
my $error; |
| 300 |
for my $er ( |
| 301 |
qw/bad-format bad-namespace-prefix conflict connection-timeout host-gone |
| 302 |
host-unknown improper-addressing internal-server-error invalid-from |
| 303 |
invalid-id invalid-namespace invalid-xml not-authorized policy-violation |
| 304 |
remote-connection-failed resource-constraint restricted-xml |
| 305 |
see-other-host system-shutdown undefined-condition unsupported-stanza-type |
| 306 |
unsupported-version xml-not-well-formed/) |
| 307 |
{ |
| 308 |
if (my (@n) = $node->find_all ([streams => $er])) { |
| 309 |
$error = $n[0]->name; |
| 310 |
last; |
| 311 |
} |
| 312 |
} |
| 313 |
|
| 314 |
unless ($error) { |
| 315 |
#d# warn "got undefined error stanza, trying to find any undefined error..."; |
| 316 |
for my $n ($node->nodes) { |
| 317 |
if ($n->eq_ns ('streams')) { |
| 318 |
$error = $n->name; |
| 319 |
} |
| 320 |
} |
| 321 |
} |
| 322 |
|
| 323 |
$self->{error_name} = $error; |
| 324 |
$self->{error_text} = @txt ? $txt[0]->text : ''; |
| 325 |
} |
| 326 |
|
| 327 |
=head2 METHODS |
| 328 |
|
| 329 |
=head3 xml_node () |
| 330 |
|
| 331 |
Returns the L<Net::XMPP2::Node> object for this stream error. |
| 332 |
|
| 333 |
=cut |
| 334 |
|
| 335 |
sub xml_node { |
| 336 |
$_[0]->{node} |
| 337 |
} |
| 338 |
|
| 339 |
=head3 name () |
| 340 |
|
| 341 |
Returns the name of the error. That might be undef, one of the following |
| 342 |
strings or some other string that has been discovered by a heuristic |
| 343 |
(because some servers send errors that are not in the RFC). |
| 344 |
|
| 345 |
bad-format |
| 346 |
bad-namespace-prefix |
| 347 |
conflict |
| 348 |
connection-timeout |
| 349 |
host-gone |
| 350 |
host-unknown |
| 351 |
improper-addressing |
| 352 |
internal-server-error |
| 353 |
invalid-from |
| 354 |
invalid-id |
| 355 |
invalid-namespace |
| 356 |
invalid-xml |
| 357 |
not-authorized |
| 358 |
policy-violation |
| 359 |
remote-connection-failed |
| 360 |
resource-constraint |
| 361 |
restricted-xml |
| 362 |
see-other-host |
| 363 |
system-shutdown |
| 364 |
undefined-condition |
| 365 |
unsupported-stanza-type |
| 366 |
unsupported-version |
| 367 |
xml-not-well-formed |
| 368 |
|
| 369 |
=cut |
| 370 |
|
| 371 |
sub name { $_[0]->{error_name} } |
| 372 |
|
| 373 |
=head3 text () |
| 374 |
|
| 375 |
The humand readable error portion. Might be undef if none was received. |
| 376 |
|
| 377 |
=cut |
| 378 |
|
| 379 |
sub text { $_[0]->{error_text} } |
| 380 |
|
| 381 |
sub string { |
| 382 |
my ($self) = @_; |
| 383 |
|
| 384 |
sprintf ("stream error: %s: %s", |
| 385 |
$self->name, |
| 386 |
$self->text) |
| 387 |
} |
| 388 |
|
| 389 |
package Net::XMPP2::Error::SASL; |
| 390 |
our @ISA = qw/Net::XMPP2::Error/; |
| 391 |
|
| 392 |
=head1 SUBCLASS |
| 393 |
|
| 394 |
Net::XMPP2::Error::SASL - SASL authentication error |
| 395 |
|
| 396 |
=cut |
| 397 |
|
| 398 |
sub init { |
| 399 |
my ($self) = @_; |
| 400 |
my $node = $self->xml_node; |
| 401 |
|
| 402 |
my $error; |
| 403 |
for ($node->nodes) { |
| 404 |
$error = $_->name; |
| 405 |
last |
| 406 |
} |
| 407 |
|
| 408 |
$self->{error_cond} = $error; |
| 409 |
} |
| 410 |
|
| 411 |
=head2 METHODS |
| 412 |
|
| 413 |
=head3 xml_node () |
| 414 |
|
| 415 |
Returns the L<Net::XMPP2::Node> object for this stream error. |
| 416 |
|
| 417 |
=cut |
| 418 |
|
| 419 |
sub xml_node { |
| 420 |
$_[0]->{node} |
| 421 |
} |
| 422 |
|
| 423 |
=head3 condition () |
| 424 |
|
| 425 |
Returns the error condition, which might be one of: |
| 426 |
|
| 427 |
aborted |
| 428 |
incorrect-encoding |
| 429 |
invalid-authzid |
| 430 |
invalid-mechanism |
| 431 |
mechanism-too-weak |
| 432 |
not-authorized |
| 433 |
temporary-auth-failure |
| 434 |
|
| 435 |
=cut |
| 436 |
|
| 437 |
sub condition { |
| 438 |
$_[0]->{error_cond} |
| 439 |
} |
| 440 |
|
| 441 |
sub string { |
| 442 |
my ($self) = @_; |
| 443 |
|
| 444 |
sprintf "sasl error: %s", |
| 445 |
$self->condition |
| 446 |
} |
| 447 |
|
| 448 |
package Net::XMPP2::Error::Register; |
| 449 |
our @ISA = qw/Net::XMPP2::Error::IQ/; |
| 450 |
|
| 451 |
=head1 SUBCLASS |
| 452 |
|
| 453 |
Net::XMPP2::Error::Register - In band registration error |
| 454 |
|
| 455 |
=cut |
| 456 |
|
| 457 |
=head2 METHODS |
| 458 |
|
| 459 |
=head3 register_state () |
| 460 |
|
| 461 |
Returns the state of registration, one of: |
| 462 |
|
| 463 |
form-request |
| 464 |
form-submitted |
| 465 |
|
| 466 |
=cut |
| 467 |
|
| 468 |
sub register_state { |
| 469 |
my ($self) = @_; |
| 470 |
$self->{register_state} |
| 471 |
} |
| 472 |
|
| 473 |
sub string { |
| 474 |
my ($self) = @_; |
| 475 |
|
| 476 |
sprintf "ibb registration error (in %s): %s", |
| 477 |
$self->register_state, |
| 478 |
$self->SUPER::string |
| 479 |
} |
| 480 |
|
| 481 |
=head1 AUTHOR |
| 482 |
|
| 483 |
Robin Redeker, C<< <elmex at ta-sa.org> >> |
| 484 |
|
| 485 |
=head1 COPYRIGHT & LICENSE |
| 486 |
|
| 487 |
Copyright 2007 Robin Redeker, all rights reserved. |
| 488 |
|
| 489 |
This program is free software; you can redistribute it and/or modify it |
| 490 |
under the same terms as Perl itself. |
| 491 |
|
| 492 |
=cut |
| 493 |
|
| 494 |
1; # End of Net::XMPP2 |
