| 1 |
package Net::XMPP2::IM::Message; |
| 2 |
use strict; |
| 3 |
use overload |
| 4 |
'""' => "to_string"; |
| 5 |
|
| 6 |
=head1 NAME |
| 7 |
|
| 8 |
Net::XMPP2::IM::Message - Instant message |
| 9 |
|
| 10 |
=head1 SYNOPSIS |
| 11 |
|
| 12 |
use Net::XMPP2::IM::Message; |
| 13 |
|
| 14 |
my $con = Net::XMPP2::IM::Connection->new (...); |
| 15 |
|
| 16 |
Net::XMPP2::IM::Message->new ( |
| 17 |
body => "Hello there!", |
| 18 |
to => "elmex@jabber.org" |
| 19 |
)->send ($con); |
| 20 |
|
| 21 |
=head1 DESCRIPTION |
| 22 |
|
| 23 |
This module represents an instant message. It's mostly |
| 24 |
a shortlived object and acts as wrapper object around the |
| 25 |
XML stuff that is happening under the hood. |
| 26 |
|
| 27 |
A L<Net::XMPP2::IM::Message> object overloads the stringification |
| 28 |
operation. The string represenation of this object is the return |
| 29 |
value of the C<any_body> method. |
| 30 |
|
| 31 |
=head1 METHODS |
| 32 |
|
| 33 |
=over 4 |
| 34 |
|
| 35 |
=item B<new (%args)> |
| 36 |
|
| 37 |
This method creates a new instance of a L<Net::XMPP2::IM::Message>. |
| 38 |
|
| 39 |
C<%args> is the argument hash. All arguments to C<new> are optional. |
| 40 |
|
| 41 |
These are the possible keys: |
| 42 |
|
| 43 |
=over 4 |
| 44 |
|
| 45 |
=item connection => $connection |
| 46 |
|
| 47 |
This is the L<Net::XMPP2::IM::Connection> object that will |
| 48 |
be used to send this message when the C<send> method is called. |
| 49 |
|
| 50 |
=item to => $jid |
| 51 |
|
| 52 |
This is the destination JID of this message. C<$jid> should |
| 53 |
be a bare JID when the message is sent out of a conversation 'context'. |
| 54 |
C<$jid> should be full if this message is send within a conversation |
| 55 |
'context', for example when replying to a previous message. |
| 56 |
|
| 57 |
Replies can also be generated by the C<make_reply> method, see also |
| 58 |
the C<from> argument below. |
| 59 |
|
| 60 |
=item from => $jid |
| 61 |
|
| 62 |
This is the source JID of this message, it's mainly |
| 63 |
used by the C<make_reply> method. |
| 64 |
|
| 65 |
=item lang => $lang |
| 66 |
|
| 67 |
This is the default language that will be used to tag the values |
| 68 |
passed in the C<body> and C<subject> argument to C<new>. |
| 69 |
|
| 70 |
=item body => $body |
| 71 |
|
| 72 |
This is the text C<$body> of the message either with the language |
| 73 |
tag from the C<lang> attached or without any language tag. |
| 74 |
|
| 75 |
If you want to attach multiple bodies with different languages use the C<add_body> |
| 76 |
method. |
| 77 |
|
| 78 |
=item subject => $subject |
| 79 |
|
| 80 |
This is the C<$subject> of the message either with the language |
| 81 |
tag from the C<lang> attached or without any language tag. |
| 82 |
|
| 83 |
If you want to attach the subject with a different language use the C<add_subject> |
| 84 |
method. |
| 85 |
|
| 86 |
=item type => $type |
| 87 |
|
| 88 |
This field sets the type of the message. See also the L<type> method below. |
| 89 |
|
| 90 |
The default value for C<$type> is 'normal'. |
| 91 |
|
| 92 |
=back |
| 93 |
|
| 94 |
=cut |
| 95 |
|
| 96 |
sub new { |
| 97 |
my $this = shift; |
| 98 |
my $class = ref($this) || $this; |
| 99 |
my $self = bless { @_ }, $class; |
| 100 |
|
| 101 |
if (my $sub = delete $self->{subject}) { |
| 102 |
$self->add_subject ($sub); |
| 103 |
} |
| 104 |
if (my $body = delete $self->{body}) { |
| 105 |
$self->add_body ($body); |
| 106 |
} |
| 107 |
|
| 108 |
$self->{type} ||= 'normal'; # default it to 'normal' |
| 109 |
$self->{lang} ||= ''; |
| 110 |
|
| 111 |
$self |
| 112 |
} |
| 113 |
|
| 114 |
sub to_string { |
| 115 |
my ($self) = @_; |
| 116 |
$self->any_body |
| 117 |
} |
| 118 |
|
| 119 |
=item B<from ([$jid])> |
| 120 |
|
| 121 |
This method returns the source JID of this message. |
| 122 |
If C<$jid> is not undef it will replace the current |
| 123 |
source address. |
| 124 |
|
| 125 |
=cut |
| 126 |
|
| 127 |
sub from { |
| 128 |
my ($self, $from) = @_; |
| 129 |
$self->{from} = $from if defined $from; |
| 130 |
$self->{from} |
| 131 |
} |
| 132 |
|
| 133 |
=item B<to ([$jid])> |
| 134 |
|
| 135 |
This method returns the destination JID of this message. |
| 136 |
If C<$jid> is not undef it will replace the current |
| 137 |
destination address. |
| 138 |
|
| 139 |
=cut |
| 140 |
|
| 141 |
sub to { |
| 142 |
my ($self, $to) = @_; |
| 143 |
$self->{to} = $to if defined $to; |
| 144 |
$self->{to} |
| 145 |
} |
| 146 |
|
| 147 |
=item B<make_reply ([$msg])> |
| 148 |
|
| 149 |
This method returns a new instance of L<Net::XMPP2::IM::Message>. |
| 150 |
The destination address, connection and type of the returned message |
| 151 |
object will be set. |
| 152 |
|
| 153 |
If C<$msg> is defined and an instance of L<Net::XMPP2::IM::Message> |
| 154 |
the destination address, connection and type of C<$msg> will be changed |
| 155 |
and this method will not return a new instance of L<Net::XMPP2::IM::Message>. |
| 156 |
|
| 157 |
=cut |
| 158 |
|
| 159 |
sub make_reply { |
| 160 |
my ($self, $msg) = @_; |
| 161 |
|
| 162 |
unless ($msg) { |
| 163 |
$msg = Net::XMPP2::IM::Message->new (); |
| 164 |
} |
| 165 |
|
| 166 |
$msg->{connection} = $self->{connection}; |
| 167 |
$msg->to ($self->from); |
| 168 |
$msg->type ($self->type); |
| 169 |
|
| 170 |
$msg |
| 171 |
} |
| 172 |
|
| 173 |
=item B<is_connected ()> |
| 174 |
|
| 175 |
This method returns 1 when the message is "connected". |
| 176 |
That means: It returns 1 when you can call the C<send> method |
| 177 |
without a connection argument. (It will also return only 1 when |
| 178 |
the connection that is referenced by this message is still |
| 179 |
connected). |
| 180 |
|
| 181 |
=cut |
| 182 |
|
| 183 |
sub is_connected { |
| 184 |
my ($self) = @_; |
| 185 |
$self->{connection}->is_connected |
| 186 |
} |
| 187 |
|
| 188 |
=item B<send ([$connection])> |
| 189 |
|
| 190 |
This method send this message. If C<$connection> |
| 191 |
is defined it will set the connection of this |
| 192 |
message object before it is send. |
| 193 |
|
| 194 |
=cut |
| 195 |
|
| 196 |
sub send { |
| 197 |
my ($self, $connection) = @_; |
| 198 |
|
| 199 |
$self->{connection} = $connection if $connection; |
| 200 |
|
| 201 |
my @add; |
| 202 |
push @add, (subject => $self->{subjects}) |
| 203 |
if %{$self->{subjects} || {}}; |
| 204 |
push @add, (thread => $self->thread) |
| 205 |
if $self->thread; |
| 206 |
|
| 207 |
$self->{connection}->send_message ( |
| 208 |
$self->to, $self->type, undef, |
| 209 |
body => $self->{bodies}, |
| 210 |
@add |
| 211 |
); |
| 212 |
} |
| 213 |
|
| 214 |
=item B<type ([$type])> |
| 215 |
|
| 216 |
This method returns the type of the message, which |
| 217 |
is either undefined or one of the following values: |
| 218 |
|
| 219 |
'chat', 'error', 'groupchat', 'headline', 'normal' |
| 220 |
|
| 221 |
If the C<$type> argument is defined it will set the type |
| 222 |
of this message. |
| 223 |
|
| 224 |
=cut |
| 225 |
|
| 226 |
sub type { |
| 227 |
my ($self, $type) = @_; |
| 228 |
$self->{type} = $type |
| 229 |
if defined $type; |
| 230 |
$self->{type} |
| 231 |
} |
| 232 |
|
| 233 |
=item B<thread ([$thread])> |
| 234 |
|
| 235 |
This method returns the thread id of this message, |
| 236 |
which might be undefined. |
| 237 |
|
| 238 |
If you want to set the threadid simply pass the C<$thread> |
| 239 |
argument. |
| 240 |
|
| 241 |
=cut |
| 242 |
|
| 243 |
sub thread { |
| 244 |
my ($self, $thread) = @_; |
| 245 |
$self->{thread} = $thread |
| 246 |
if defined $thread; |
| 247 |
$self->{thread} |
| 248 |
} |
| 249 |
|
| 250 |
=item B<lang ([$lang])> |
| 251 |
|
| 252 |
This returns the default language tag of this message, |
| 253 |
which can be undefined. |
| 254 |
|
| 255 |
To set the language tag pass the C<$lang> argument, which |
| 256 |
should be the new default language tag. |
| 257 |
|
| 258 |
If you do not want to specify any language pass the empty |
| 259 |
string as language tag. |
| 260 |
|
| 261 |
=cut |
| 262 |
|
| 263 |
sub lang { |
| 264 |
my ($self, $lang) = @_; |
| 265 |
$self->{lang} = $lang |
| 266 |
if defined $lang; |
| 267 |
$self->{lang} |
| 268 |
} |
| 269 |
|
| 270 |
=item B<subject ([$lang])> |
| 271 |
|
| 272 |
This method returns the subject of this message. |
| 273 |
If the C<$lang> argument is defined a subject of that |
| 274 |
language will be returned or undef. |
| 275 |
If the C<$lang> argument is undefined this method will |
| 276 |
return either the subject in the default language. |
| 277 |
|
| 278 |
=cut |
| 279 |
|
| 280 |
sub subject { |
| 281 |
my ($self, $lang) = @_; |
| 282 |
|
| 283 |
if (defined $lang) { |
| 284 |
return $self->{subjects}->{$lang} |
| 285 |
} |
| 286 |
|
| 287 |
return $self->{subjects}->{$self->{lang}}; |
| 288 |
|
| 289 |
undef |
| 290 |
} |
| 291 |
|
| 292 |
=item B<any_subject ([$lang])> |
| 293 |
|
| 294 |
This method will try to find any subject on the message with the |
| 295 |
following try order of languagetags: |
| 296 |
|
| 297 |
1. $lang argument if one passed |
| 298 |
2. default language |
| 299 |
3. subject without any language tag |
| 300 |
4. subject with the 'en' language tag |
| 301 |
5. any subject from any language |
| 302 |
|
| 303 |
=cut |
| 304 |
|
| 305 |
sub any_subject { |
| 306 |
my ($self, $lang) = @_; |
| 307 |
if (defined $lang) { |
| 308 |
return $self->{subjects}->{$lang} |
| 309 |
if defined $self->{subjects}->{$lang}; |
| 310 |
} |
| 311 |
return $self->{subjects}->{$self->{lang}} |
| 312 |
if defined $self->{subjects}->{$self->{lang}}; |
| 313 |
return $self->{subjects}->{''} |
| 314 |
if defined $self->{subjects}->{''}; |
| 315 |
return $self->{subjects}->{en} |
| 316 |
if defined $self->{subjects}->{en}; |
| 317 |
return $self->{subjects}->{$_} for (keys %{$self->{subjects}}); |
| 318 |
return undef; |
| 319 |
} |
| 320 |
|
| 321 |
=item B<add_subject ($subject, [$lang], [$subject2, $lang2, ...])> |
| 322 |
|
| 323 |
This method adds the subject C<$subject> with the optional |
| 324 |
language tag C<$lang> to this message. If no C<$lang> |
| 325 |
argument is passed the default language for this message will be used. |
| 326 |
|
| 327 |
Further subject => lang pairs can passed to this function like this: |
| 328 |
|
| 329 |
$msg->add_subject ('foobar' => undef, "barfooo" => "de"); |
| 330 |
|
| 331 |
=cut |
| 332 |
|
| 333 |
sub add_subject { |
| 334 |
my $self = shift; |
| 335 |
while (@_) { |
| 336 |
my $subj = shift; |
| 337 |
my $lang = shift; |
| 338 |
$self->{subjects}->{$lang || $self->{lang}} = $subj; |
| 339 |
} |
| 340 |
$self |
| 341 |
} |
| 342 |
|
| 343 |
=item B<subjects> |
| 344 |
|
| 345 |
This method returns a list of key value pairs |
| 346 |
with the language tag as key and the subject as value. |
| 347 |
|
| 348 |
The subject which has the empty string as key has no |
| 349 |
language attached. |
| 350 |
|
| 351 |
=cut |
| 352 |
|
| 353 |
sub subjects { |
| 354 |
%{$_[0]->{subjects} || {}} |
| 355 |
} |
| 356 |
|
| 357 |
=item B<body ([$lang])> |
| 358 |
|
| 359 |
This method returns the body of this message. |
| 360 |
If the C<$lang> argument is defined a body of that |
| 361 |
language will be returned or undef. |
| 362 |
If the C<$lang> argument is undefined this method will |
| 363 |
return either the body in the default language. |
| 364 |
|
| 365 |
=cut |
| 366 |
|
| 367 |
sub body { |
| 368 |
my ($self, $lang) = @_; |
| 369 |
|
| 370 |
if (defined $lang) { |
| 371 |
return $self->{bodies}->{$lang} |
| 372 |
} else { |
| 373 |
return $self->{bodies}->{$self->{lang}} |
| 374 |
if defined $self->{bodies}->{$self->{lang}}; |
| 375 |
} |
| 376 |
|
| 377 |
undef |
| 378 |
} |
| 379 |
|
| 380 |
=item B<any_body ([$lang])> |
| 381 |
|
| 382 |
This method will try to find any body on the message with the |
| 383 |
following try order of languagetags: |
| 384 |
|
| 385 |
1. $lang argument if one passed |
| 386 |
2. default language |
| 387 |
3. body without any language tag |
| 388 |
4. body with the 'en' language tag |
| 389 |
5. any body from any language |
| 390 |
|
| 391 |
=cut |
| 392 |
|
| 393 |
sub any_body { |
| 394 |
my ($self, $lang) = @_; |
| 395 |
if (defined $lang) { |
| 396 |
return $self->{bodies}->{$lang} |
| 397 |
if defined $self->{bodies}->{$lang}; |
| 398 |
} |
| 399 |
return $self->{bodies}->{$self->{lang}} |
| 400 |
if defined $self->{bodies}->{$self->{lang}}; |
| 401 |
return $self->{bodies}->{''} |
| 402 |
if defined $self->{bodies}->{''}; |
| 403 |
return $self->{bodies}->{en} |
| 404 |
if defined $self->{bodies}->{en}; |
| 405 |
return $self->{bodies}->{$_} for (keys %{$self->{bodies}}); |
| 406 |
return undef; |
| 407 |
} |
| 408 |
|
| 409 |
=item B<add_body ($body, [$lang], [$body2, $lang2, ...])> |
| 410 |
|
| 411 |
This method adds the body C<$body> with the optional |
| 412 |
language tag C<$lang> to this message. If no C<$lang> |
| 413 |
argument is passed the default language for this message will be used. |
| 414 |
|
| 415 |
Further body => lang pairs can passed to this function like this: |
| 416 |
|
| 417 |
$msg->add_body ('foobar' => undef, "barfooo" => "de"); |
| 418 |
|
| 419 |
=cut |
| 420 |
|
| 421 |
sub add_body { |
| 422 |
my $self = shift; |
| 423 |
while (@_) { |
| 424 |
my $body = shift; |
| 425 |
my $lang = shift; |
| 426 |
$self->{bodies}->{$lang || $self->{lang}} = $body; |
| 427 |
} |
| 428 |
$self |
| 429 |
} |
| 430 |
|
| 431 |
=item B<bodies> |
| 432 |
|
| 433 |
This method returns a list of key value pairs |
| 434 |
with the language tag as key and the body as value. |
| 435 |
|
| 436 |
The body which has the empty string as key has no |
| 437 |
language attached. |
| 438 |
|
| 439 |
=cut |
| 440 |
|
| 441 |
sub bodies { |
| 442 |
%{$_[0]->{bodies} || {}} |
| 443 |
} |
| 444 |
|
| 445 |
=back |
| 446 |
|
| 447 |
=head1 AUTHOR |
| 448 |
|
| 449 |
Robin Redeker, C<< <elmex at ta-sa.org> >>, JID: C<< <elmex at jabber.org> >> |
| 450 |
|
| 451 |
=head1 COPYRIGHT & LICENSE |
| 452 |
|
| 453 |
Copyright 2007 Robin Redeker, all rights reserved. |
| 454 |
|
| 455 |
This program is free software; you can redistribute it and/or modify it |
| 456 |
under the same terms as Perl itself. |
| 457 |
|
| 458 |
=cut |
| 459 |
|
| 460 |
1; # End of Net::XMPP2 |
