/usr/share/perl5/Net/XMPP/Presence.pm is in libnet-xmpp-perl 1.05-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 | #############################################################################
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Library General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Library General Public License for more details.
#
# You should have received a copy of the GNU Library General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA.
#
# Copyright (C) 1998-2004 Jabber Software Foundation http://jabber.org/
#
##############################################################################
package Net::XMPP::Presence;
=head1 NAME
Net::XMPP::Presence - XMPP Presence Module
=head1 SYNOPSIS
Net::XMPP::Presence is a companion to the Net::XMPP module.
It provides the user a simple interface to set and retrieve all
parts of an XMPP Presence.
=head1 DESCRIPTION
A Net::XMPP::Presence object is passed to the callback function for
the message. Also, the first argument to the callback functions is
the session ID from XML::Streams. There are some cases where you
might want this information, like if you created a Client that
connects to two servers at once, or for writing a mini server.
use Net::XMPP;
sub presence {
my ($sid,$Pres) = @_;
.
.
.
}
You now have access to all of the retrieval functions available.
To create a new presence to send to the server:
use Net::XMPP;
$Pres = Net::XMPP::Presence->new();
Now you can call the creation functions below to populate the tag
before sending it.
=head1 METHODS
=head2 Retrieval functions
=over 4
=item GetTo
GetTo()
returns the value in the to='' attribute for the <presence/>.
GetTo("jid")
If you specify "jid" as an argument
then a Net::XMPP::JID object is returned and
you can easily parse the parts of the JID.
$to = $Pres->GetTo();
$toJID = $Pres->GetTo("jid");
=item GetFrom
GetFrom()
returns the value in the from='' attribute for the <presence/>.
GetFrom("jid")
If you specify "jid" as an argument
then a Net::XMPP::JID object is returned and
you can easily parse the parts of the JID.
$from = $Pres->GetFrom();
$fromJID = $Pres->GetFrom("jid");
=item GetType
GetType()
returns the type='' attribute of the <presence/>. Each
presence is one of seven types:
available available to receive messages; default
unavailable unavailable to receive anything
subscribe ask the recipient to subscribe you
subscribed tell the sender they are subscribed
unsubscribe ask the recipient to unsubscribe you
unsubscribed tell the sender they are unsubscribed
probe probe
$type = $Pres->GetType();
=item GetStatus
GetStatus()
returns a string with the current status of the resource.
$status = $Pres->GetStatus();
=item GetPriority
GetPriority()
returns an integer with the priority of the resource
The default is 0 if there is no priority in this
presence.
$priority = $Pres->GetPriority();
=item GetShow
GetShow()
Returns a string with the state the client should show.
$show = $Pres->GetShow();
=back
=head2 Creation functions
=over 4
=item SetPresence
SetPresence(to=>string|JID
from=>string|JID,
type=>string,
status=>string,
priority=>integer,
meta=>string,
icon=>string,
show=>string,
loc=>string)
set multiple fields in the <presence/>
at one time. This is a cumulative
and over writing action. If you set
the "to" attribute twice, the second
setting is what is used. If you set
the status, and then set the priority
then both will be in the <presence/>
tag. For valid settings read the
specific Set functions below.
$Pres->SetPresence(TYPE=>"away", StatuS=>"Out for lunch");
=item SetTo
SetTo(string)
SetTo(JID)
sets the to attribute. You can either pass a string
or a JID object. They must be valid JIDs or the
server will return an error message.
(ie. bob@jabber.org/Silent Bob, etc...)
$Pres->SetTo("bob\@jabber.org");
=item SetFrom
SetFrom(string)
sets the from='' attribute. You can either pass
SetFrom(JID)
A string or a JID object. They must be valid JIDs
or the server will return an error message. (ie.
jabber:bob@jabber.org/Work) This field is not
required if you are writing a Client since the
server will put the JID of your connection in there
to prevent spamming.
$Pres->SetFrom("jojo\@jabber.org");
=item SetType
SetType(string)
sets the type attribute. Valid settings are:
available available to receive messages; default
unavailable unavailable to receive anything
subscribe ask the recipient to subscribe you
subscribed tell the sender they are subscribed
unsubscribe ask the recipient to unsubscribe you
unsubscribed tell the sender they are unsubscribed
probe probe
$Pres->SetType("unavailable");
=item SetStatus
SetStatus(string)
sets the status tag to be whatever string the user
wants associated with that resource.
$Pres->SetStatus("Taking a nap");
=item SetPriority
SetPriority(integer)
sets the priority of this resource. The highest
resource attached to the xmpp account is the
one that receives the messages.
$Pres->SetPriority(10);
=item SetShow
SetShow(string)
Sets the name of the icon or string to display for this resource.
$Pres->SetShow("away");
=item Reply
Reply(hash)
creates a new Presence object and populates the to/from
fields. If you specify a hash the same as with
SetPresence then those values will override the Reply
values.
$Reply = $Pres->Reply();
$Reply = $Pres->Reply(type=>"subscribed");
=back
=head2 Removal functions
=over 4
=item RemoveTo
removes the to attribute from the <presence/>.
$Pres->RemoveTo();
=item RemoveFrom
removes the from attribute from the <presence/>.
$Pres->RemoveFrom();
=item RemoveType
removes the type attribute from the <presence/>.
$Pres->RemoveType();
=item RemoveStatus
removes the <status/> element from the <presence/>.
$Pres->RemoveStatus();
=item RemovePriority
removes the <priority/> element from the <presence/>.
$Pres->RemovePriority();
=item RemoveShow
removes the <show/> element from the <presence/>.
$Pres->RemoveShow();
=back
=head2 Test functions
=over 4
=item DefinedTo
returns 1 if the to attribute is defined in the <presence/>, 0 otherwise.
$test = $Pres->DefinedTo();
=item DefinedFrom
returns 1 if the from attribute is defined in the <presence/>, 0 otherwise.
$test = $Pres->DefinedFrom();
=item DefinedType
returns 1 if the type attribute is defined in the <presence/>, 0 otherwise.
$test = $Pres->DefinedType();
=item DefinedStatus
returns 1 if <status/> is defined in the <presence/>, 0 otherwise.
$test = $Pres->DefinedStatus();
=item DefinedPriority
returns 1 if <priority/> is defined in the <presence/>, 0 otherwise.
$test = $Pres->DefinedPriority();
=item DefinedShow
returns 1 if <show/> is defined in the <presence/>, 0 otherwise.
$test = $Pres->DefinedShow();
=back
=head1 AUTHOR
Originally authored by Ryan Eatmon.
Previously maintained by Eric Hacker.
Currently maintained by Darian Anthony Patrick.
=head1 COPYRIGHT
This module is free software, you can redistribute it and/or modify it
under the LGPL 2.1.
=cut
require 5.008;
use strict;
use warnings;
use Carp;
use vars qw( %FUNCTIONS );
use Net::XMPP::Stanza;
use base qw( Net::XMPP::Stanza );
sub new
{
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = { };
bless($self, $proto);
$self->{DEBUGHEADER} = "Presence";
$self->{TAG} = "presence";
$self->{FUNCS} = \%FUNCTIONS;
$self->_init(@_);
return $self;
}
sub _presence { return Net::XMPP::Presence->new(); }
$FUNCTIONS{Error}->{path} = 'error/text()';
$FUNCTIONS{ErrorCode}->{path} = 'error/@code';
$FUNCTIONS{From}->{type} = 'jid';
$FUNCTIONS{From}->{path} = '@from';
$FUNCTIONS{ID}->{path} = '@id';
$FUNCTIONS{Priority}->{path} = 'priority/text()';
$FUNCTIONS{Show}->{path} = 'show/text()';
$FUNCTIONS{Status}->{path} = 'status/text()';
$FUNCTIONS{To}->{type} = 'jid';
$FUNCTIONS{To}->{path} = '@to';
$FUNCTIONS{Type}->{path} = '@type';
$FUNCTIONS{XMLNS}->{path} = '@xmlns';
$FUNCTIONS{Presence}->{type} = 'master';
$FUNCTIONS{Child}->{type} = 'child';
$FUNCTIONS{Child}->{path} = '*[@xmlns]';
$FUNCTIONS{Child}->{child} = {};
##############################################################################
#
# Reply - returns a Net::XMPP::Presence object with the proper fields
# already populated for you.
#
##############################################################################
sub Reply
{
my $self = shift;
my %args;
while($#_ >= 0) { $args{ lc pop(@_) } = pop(@_); }
my $reply = $self->_presence();
$reply->SetID($self->GetID()) if ($self->GetID() ne "");
$reply->SetPresence((($self->GetFrom() ne "") ?
(to=>$self->GetFrom()) :
()
),
(($self->GetTo() ne "") ?
(from=>$self->GetTo()) :
()
),
);
$reply->SetPresence(%args);
return $reply;
}
1;
|