source: perl/modules/jabber.pl @ 0a3f04d

barnowl_perlaimdebianrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 0a3f04d was 0a3f04d, checked in by Nelson Elhage <nelhage@mit.edu>, 14 years ago
Some bugfixing to JID guessing.
  • Property mode set to 100644
File size: 38.6 KB
Line 
1# -*- mode: cperl; cperl-indent-level: 4; indent-tabs-mode: nil -*-
2package BarnOwl::Jabber;
3use warnings;
4use strict;
5
6use Authen::SASL qw(Perl);
7use Net::Jabber;
8use Net::Jabber::MUC;
9use Net::DNS;
10use Getopt::Long;
11
12no warnings 'redefine';
13
14################################################################################
15# owl perl jabber support
16#
17# XXX Todo:
18# Rosters for MUCs
19# More user feedback
20#  * joining MUC
21#  * parting MUC
22#  * presence (Roster and MUC)
23# Implementing formatting and logging callbacks for C
24# Appropriate callbacks for presence subscription messages.
25#
26################################################################################
27
28
29################################################################################
30################################################################################
31package BarnOwl::Jabber::Connection;
32
33use base qw(Net::Jabber::Client);
34
35sub new {
36    my $class = shift;
37
38    my %args = ();
39    if(BarnOwl::getvar('debug') eq 'on') {
40        $args{debuglevel} = 1;
41        $args{debugfile} = 'jabber.log';
42    }
43    my $self = $class->SUPER::new(%args);
44    $self->{_BARNOWL_MUCS} = [];
45    return $self;
46}
47
48=head2 MUCJoin
49
50Extends MUCJoin to keep track of the MUCs we're joined to as
51Net::Jabber::MUC objects. Takes the same arguments as
52L<Net::Jabber::MUC/new> and L<Net::Jabber::MUC/Connect>
53
54=cut
55
56sub MUCJoin {
57    my $self = shift;
58    my $muc = Net::Jabber::MUC->new(connection => $self, @_);
59    $muc->Join(@_);
60    push @{$self->MUCs}, $muc;
61}
62
63=head2 MUCLeave ARGS
64
65Leave a MUC. The MUC is specified in the same form as L</FindMUC>
66
67=cut
68
69sub MUCLeave {
70    my $self = shift;
71    my $muc = $self->FindMUC(@_);
72    return unless $muc;
73
74    $muc->Leave();
75    $self->{_BARNOWL_MUCS} = [grep {$_->BaseJID ne $muc->BaseJID} $self->MUCs];
76}
77
78=head2 FindMUC ARGS
79
80Return the Net::Jabber::MUC object representing a specific MUC we're
81joined to, undef if it doesn't exists. ARGS can be either JID => $JID,
82or Room => $room, Server => $server.
83
84=cut
85
86sub FindMUC {
87    my $self = shift;
88
89    my %args;
90    while($#_ >= 0) { $args{ lc(pop(@_)) } = pop(@_); }
91
92    my $jid;
93    if($args{jid}) {
94        $jid = $args{jid};
95    } elsif($args{room} && $args{server}) {
96        $jid = Net::Jabber::JID->new(userid => $args{room},
97                                     server => $args{server});
98    }
99    $jid = $jid->GetJID('base') if UNIVERSAL::isa($jid, 'Net::Jabber::JID');
100
101    foreach my $muc ($self->MUCs) {
102        return $muc if $muc->BaseJID eq $jid;
103    }
104    return undef;
105}
106
107=head2 MUCs
108
109Returns a list (or arrayref in scalar context) of Net::Jabber::MUC
110objects we believe ourself to be connected to.
111
112=cut
113
114sub MUCs {
115    my $self = shift;
116    my $mucs = $self->{_BARNOWL_MUCS};
117    return wantarray ? @$mucs : $mucs;
118}
119
120################################################################################
121################################################################################
122package BarnOwl::Jabber::ConnectionManager;
123sub new {
124    my $class = shift;
125    return bless { }, $class;
126}
127
128sub addConnection {
129    my $self = shift;
130    my $jidStr = shift;
131
132    my $client = BarnOwl::Jabber::Connection->new;
133
134    $self->{$jidStr}->{Client} = $client;
135    $self->{$jidStr}->{Roster} = $client->Roster();
136    $self->{$jidStr}->{Status} = "available";
137    return $client;
138}
139
140sub removeConnection {
141    my $self = shift;
142    my $jidStr = shift;
143    return 0 unless exists $self->{$jidStr}->{Client};
144
145    $self->{$jidStr}->{Client}->Disconnect();
146    delete $self->{$jidStr};
147
148    return 1;
149}
150
151sub connected {
152    my $self = shift;
153    return scalar keys %{ $self };
154}
155
156sub getJids {
157    my $self = shift;
158    return keys %{ $self };
159}
160
161sub jidExists {
162    my $self = shift;
163    my $jidStr = shift;
164    return exists $self->{$jidStr};
165}
166
167sub sidExists {
168    my $self = shift;
169    my $sid = shift || "";
170    foreach my $c ( values %{ $self } ) {
171        return 1 if ($c->{Client}->{SESSION}->{id} eq $sid);
172    }
173    return 0;
174}
175
176sub getConnectionFromSid {
177    my $self = shift;
178    my $sid = shift;
179    foreach my $c (values %{ $self }) {
180        return $c->{Client} if $c->{Client}->{SESSION}->{id} eq $sid;
181    }
182    return undef;
183}
184
185sub getConnectionFromJID {
186    my $self = shift;
187    my $jid = shift;
188    $jid = $jid->GetJID('full') if UNIVERSAL::isa($jid, 'Net::XMPP::JID');
189    return $self->{$jid}->{Client} if exists $self->{$jid};
190}
191
192sub getRosterFromSid {
193    my $self = shift;
194    my $sid = shift;
195    foreach my $c (values %{ $self }) {
196        return $c->{Roster}
197          if $c->{Client}->{SESSION}->{id} eq $sid;
198    }
199    return undef;
200}
201
202sub getRosterFromJID {
203    my $self = shift;
204    my $jid = shift;
205    $jid = $jid->GetJID('full') if UNIVERSAL::isa($jid, 'Net::XMPP::JID');
206    return $self->{$jid}->{Roster} if exists $self->{$jid};
207}
208################################################################################
209
210package BarnOwl::Jabber;
211
212our $conn = new BarnOwl::Jabber::ConnectionManager unless $conn;;
213our %vars;
214
215sub onStart {
216    if ( *BarnOwl::queue_message{CODE} ) {
217        register_owl_commands();
218        push @::onMainLoop,     sub { BarnOwl::Jabber::onMainLoop(@_) };
219        push @::onGetBuddyList, sub { BarnOwl::Jabber::onGetBuddyList(@_) };
220        $vars{show} = '';
221    } else {
222        # Our owl doesn't support queue_message. Unfortunately, this
223        # means it probably *also* doesn't support BarnOwl::error. So just
224        # give up silently.
225    }
226}
227
228push @::onStartSubs, sub { BarnOwl::Jabber::onStart(@_) };
229
230sub onMainLoop {
231    return if ( !$conn->connected() );
232
233    $vars{status_changed} = 0;
234    my $idletime = owl::getidletime();
235    if ($idletime >= 900 && $vars{show} eq 'away') {
236        $vars{show} = 'xa';
237        $vars{status} = 'Auto extended-away after 15 minutes idle.';
238        $vars{status_changed} = 1;
239    } elsif ($idletime >= 300 && $vars{show} eq '') {
240        $vars{show} = 'away';
241        $vars{status} = 'Auto away after 5 minutes idle.';
242        $vars{status_changed} = 1;
243    } elsif ($idletime == 0 && $vars{show} ne '') {
244        $vars{show} = '';
245        $vars{status} = '';
246        $vars{status_changed} = 1;
247    }
248
249    foreach my $jid ( $conn->getJids() ) {
250        my $client = $conn->getConnectionFromJID($jid);
251
252        unless($client) {
253            $conn->removeConnection($jid);
254            BarnOwl::error("Connection for $jid undefined -- error in reload?");
255        }
256       
257        my $status = $client->Process(0);
258        if ( !defined($status) ) {
259            BarnOwl::error("Jabber account $jid disconnected!");
260            do_logout($jid);
261        }
262        if ($::shutdown) {
263            do_logout($jid);
264            return;
265        }
266        if ($vars{status_changed}) {
267            my $p = new Net::XMPP::Presence;
268            $p->SetShow($vars{show}) if $vars{show};
269            $p->SetStatus($vars{status}) if $vars{status};
270            $client->Send($p);
271        }
272    }
273}
274
275sub blist_listBuddy {
276    my $roster = shift;
277    my $buddy  = shift;
278    my $blistStr .= "    ";
279    my %jq  = $roster->query($buddy);
280    my $res = $roster->resource($buddy);
281
282    my $name = $jq{name} || $buddy->GetUserID();
283
284    $blistStr .= sprintf '%-15s %s', $name, $buddy->GetJID();
285
286    if ($res) {
287        my %rq = $roster->resourceQuery( $buddy, $res );
288        $blistStr .= " [" . ( $rq{show} ? $rq{show} : 'online' ) . "]";
289        $blistStr .= " " . $rq{status} if $rq{status};
290        $blistStr = boldify($blistStr);
291    }
292    else {
293        if ($jq{ask}) {
294            $blistStr .= " [pending]";
295        }
296        elsif ($jq{subscription} eq 'none' || $jq{subscription} eq 'from') {
297            $blistStr .= " [not subscribed]";
298        }
299        else {
300            $blistStr .= " [offline]";
301        }
302    }
303    return $blistStr . "\n";
304}
305
306sub getSingleBuddyList {
307    my $jid = shift;
308    $jid = resolveConnectedJID($jid);
309    return "" unless $jid;
310    my $blist = "";
311    my $roster = $conn->getRosterFromJID($jid);
312    if ($roster) {
313        $blist .= "\n" . boldify("Jabber Roster for $jid\n");
314
315        foreach my $group ( $roster->groups() ) {
316            $blist .= "  Group: $group\n";
317            my @buddies = $roster->jids( 'group', $group );
318            foreach my $buddy ( @buddies ) {
319                $blist .= blist_listBuddy( $roster, $buddy );
320            }
321        }
322
323        my @unsorted = $roster->jids('nogroup');
324        if (@unsorted) {
325            $blist .= "  [unsorted]\n";
326            foreach my $buddy (@unsorted) {
327                $blist .= blist_listBuddy( $roster, $buddy );
328            }
329        }
330    }
331    return $blist;
332}
333
334sub onGetBuddyList {
335    my $blist = "";
336    foreach my $jid ($conn->getJids()) {
337        $blist .= getSingleBuddyList($jid);
338    }
339    return $blist;
340}
341
342################################################################################
343### Owl Commands
344sub register_owl_commands() {
345    BarnOwl::new_command(
346        jabberlogin => \&cmd_login,
347        { summary => "Log into jabber", },
348        { usage   => "jabberlogin JID" }
349    );
350    BarnOwl::new_command(
351        jabberlogout => \&cmd_logout,
352        { summary => "Log out of jabber" }
353    );
354    BarnOwl::new_command(
355        jwrite => \&cmd_jwrite,
356        {
357            summary => "Send a Jabber Message",
358            usage   => "jwrite JID [-t thread] [-s subject]"
359        }
360    );
361    BarnOwl::new_command(
362        jlist => \&cmd_jlist,
363        {
364            summary => "Show your Jabber roster.",
365            usage   => "jlist"
366        }
367    );
368    BarnOwl::new_command(
369        jmuc => \&cmd_jmuc,
370        {
371            summary     => "Jabber MUC related commands.",
372            description => "jmuc sends jabber commands related to muc.\n\n"
373              . "The following commands are available\n\n"
374              . "join MUC    Join a muc.\n\n"
375              . "part MUC    Part a muc.\n"
376              . "            The muc is taken from the current message if not supplied.\n\n"
377              . "invite JID MUC\n"
378              . "            Invite JID to MUC.\n"
379              . "            The muc is taken from the current message if not supplied.\n\n"
380              . "configure MUC\n"
381              . "            Configure [muc].\n"
382              . "            Necessary to initalize a new MUC\n"
383              . "            At present, only the default configuration is supported.",
384            usage => "jmuc COMMAND ARGS"
385        }
386    );
387    BarnOwl::new_command(
388        jroster => \&cmd_jroster,
389        {
390            summary     => "Jabber Roster related commands.",
391            description => "jroster sends jabber commands related to rosters.\n\n",
392            usage       => "jroster COMMAND ARGS"
393        }
394    );
395}
396
397sub cmd_login {
398    my $cmd = shift;
399    my $jid = new Net::XMPP::JID;
400    $jid->SetJID(shift);
401
402    my $uid           = $jid->GetUserID();
403    my $componentname = $jid->GetServer();
404    my $resource      = $jid->GetResource() || 'owl';
405    $jid->SetResource($resource);
406    my $jidStr = $jid->GetJID('full');
407
408    if ( !$uid || !$componentname ) {
409        BarnOwl::error("usage: $cmd JID");
410        return;
411    }
412
413    if ( $conn->jidExists($jidStr) ) {
414        BarnOwl::error("Already logged in as $jidStr.");
415        return;
416    }
417
418    my ( $server, $port ) = getServerFromJID($jid);
419
420    $vars{jlogin_jid} = $jidStr;
421    $vars{jlogin_havepass} = 0;
422    $vars{jlogin_connhash} = {
423        hostname      => $server,
424        tls           => 1,
425        port          => $port,
426        componentname => $componentname
427    };
428    $vars{jlogin_authhash} =
429      { username => $uid,
430        resource => $resource,
431    };
432
433    return do_login('');
434}
435
436sub do_login {
437    $vars{jlogin_password} = shift;
438    $vars{jlogin_authhash}->{password} = sub { return $vars{jlogin_password} || '' };
439    my $jidStr = $vars{jlogin_jid};
440    if ( !$jidStr && $vars{jlogin_havepass}) {
441        BarnOwl::error("Got password but have no jid!");
442    }
443    else
444    {
445        my $client = $conn->addConnection($jidStr);
446
447        #XXX Todo: Add more callbacks.
448        # * MUC presence handlers
449        # We use the anonymous subrefs in order to have the correct behavior
450        # when we reload
451        $client->SetMessageCallBacks(
452            chat      => sub { BarnOwl::Jabber::process_incoming_chat_message(@_) },
453            error     => sub { BarnOwl::Jabber::process_incoming_error_message(@_) },
454            groupchat => sub { BarnOwl::Jabber::process_incoming_groupchat_message(@_) },
455            headline  => sub { BarnOwl::Jabber::process_incoming_headline_message(@_) },
456            normal    => sub { BarnOwl::Jabber::process_incoming_normal_message(@_) }
457        );
458        $client->SetPresenceCallBacks(
459            available    => sub { BarnOwl::Jabber::process_presence_available(@_) },
460            unavailable  => sub { BarnOwl::Jabber::process_presence_available(@_) },
461            subscribe    => sub { BarnOwl::Jabber::process_presence_subscribe(@_) },
462            subscribed   => sub { BarnOwl::Jabber::process_presence_subscribed(@_) },
463            unsubscribe  => sub { BarnOwl::Jabber::process_presence_unsubscribe(@_) },
464            unsubscribed => sub { BarnOwl::Jabber::process_presence_unsubscribed(@_) },
465            error        => sub { BarnOwl::Jabber::process_presence_error(@_) });
466
467        my $status = $client->Connect( %{ $vars{jlogin_connhash} } );
468        if ( !$status ) {
469            $conn->removeConnection($jidStr);
470            BarnOwl::error("We failed to connect");
471        } else {
472            my @result = $client->AuthSend( %{ $vars{jlogin_authhash} } );
473
474            if ( !@result || $result[0] ne 'ok' ) {
475                if ( !$vars{jlogin_havepass} && ( !@result || $result[0] eq '401' ) ) {
476                    $vars{jlogin_havepass} = 1;
477                    $conn->removeConnection($jidStr);
478                    BarnOwl::start_password( "Password for $jidStr: ", \&do_login );
479                    return "";
480                }
481                $conn->removeConnection($jidStr);
482                BarnOwl::error( "Error in connect: " . join( " ", @result ) );
483            } else {
484                $conn->getRosterFromJID($jidStr)->fetch();
485                $client->PresenceSend( priority => 1 );
486                queue_admin_msg("Connected to jabber as $jidStr");
487            }
488        }
489
490    }
491    delete $vars{jlogin_jid};
492    $vars{jlogin_password} =~ tr/\0-\377/x/;
493    delete $vars{jlogin_password};
494    delete $vars{jlogin_havepass};
495    delete $vars{jlogin_connhash};
496    delete $vars{jlogin_authhash};
497    return "";
498}
499
500sub do_logout {
501    my $jid = shift;
502    my $disconnected = $conn->removeConnection($jid);
503    queue_admin_msg("Jabber disconnected ($jid).") if $disconnected;
504}
505
506sub cmd_logout {
507    # Logged into multiple accounts
508    if ( $conn->connected() > 1 ) {
509        # Logged into multiple accounts, no accout specified.
510        if ( !$_[1] ) {
511            my $errStr =
512              "You are logged into multiple accounts. Please specify an account to log out of.\n";
513            foreach my $jid ( $conn->getJids() ) {
514                $errStr .= "\t$jid\n";
515            }
516            queue_admin_msg($errStr);
517        }
518        # Logged into multiple accounts, account specified.
519        else {
520            if ( $_[1] eq '-a' )    #All accounts.
521            {
522                foreach my $jid ( $conn->getJids() ) {
523                    do_logout($jid);
524                }
525            }
526            else                    #One account.
527            {
528                my $jid = resolveConnectedJID( $_[1] );
529                do_logout($jid) if ( $jid ne '' );
530            }
531        }
532    }
533    else                            # Only one account logged in.
534    {
535        do_logout( ( $conn->getJids() )[0] );
536    }
537    return "";
538}
539
540sub cmd_jlist {
541    if ( !( scalar $conn->getJids() ) ) {
542        BarnOwl::error("You are not logged in to Jabber.");
543        return;
544    }
545    BarnOwl::popless_ztext( onGetBuddyList() );
546}
547
548sub cmd_jwrite {
549    if ( !$conn->connected() ) {
550        BarnOwl::error("You are not logged in to Jabber.");
551        return;
552    }
553
554    my $jwrite_to      = "";
555    my $jwrite_from    = "";
556    my $jwrite_sid     = "";
557    my $jwrite_thread  = "";
558    my $jwrite_subject = "";
559    my $to;
560    my $jwrite_type    = "chat";
561
562    my @args = @_;
563    shift;
564    local @ARGV = @_;
565    my $gc;
566    GetOptions(
567        'thread=s'  => \$jwrite_thread,
568        'subject=s' => \$jwrite_subject,
569        'account=s' => \$jwrite_from,
570        'id=s'     =>  \$jwrite_sid,
571    );
572    $jwrite_type = 'groupchat' if $gc;
573
574    if ( scalar @ARGV != 1 ) {
575        BarnOwl::error(
576            "Usage: jwrite JID [-t thread] [-s 'subject'] [-a account]");
577        return;
578    }
579    else {
580        $to = shift @ARGV;
581    }
582
583    ($jwrite_from, $jwrite_to, $jwrite_type) = guess_jwrite($jwrite_from, $to);
584   
585    unless($jwrite_to) {
586        die("Unable to resolve JID $to");
587    }
588
589    unless($jwrite_from) {
590        die("Unable to resolve account");
591    }
592   
593    $vars{jwrite} = {
594        to      => $jwrite_to,
595        from    => $jwrite_from,
596        sid     => $jwrite_sid,
597        subject => $jwrite_subject,
598        thread  => $jwrite_thread,
599        type    => $jwrite_type
600    };
601
602    BarnOwl::message(
603"Type your message below.  End with a dot on a line by itself.  ^C will quit."
604    );
605    my $cmd = "jwrite $jwrite_to -a $jwrite_from";
606    $cmd .= " -t $jwrite_thread" if $jwrite_thread;
607    $cmd .= " -t $jwrite_subject" if $jwrite_subject;
608    BarnOwl::start_edit_win( $cmd, \&process_owl_jwrite );
609}
610
611sub cmd_jmuc {
612    die "You are not logged in to Jabber" unless $conn->connected();
613    my $ocmd = shift;
614    my $cmd  = shift;
615    if ( !$cmd ) {
616
617        #XXX TODO: Write general usage for jmuc command.
618        return;
619    }
620
621    my %jmuc_commands = (
622        join      => \&jmuc_join,
623        part      => \&jmuc_part,
624        invite    => \&jmuc_invite,
625        configure => \&jmuc_configure,
626        presence  => \&jmuc_presence
627    );
628    my $func = $jmuc_commands{$cmd};
629    if ( !$func ) {
630        BarnOwl::error("jmuc: Unknown command: $cmd");
631        return;
632    }
633
634    {
635        local @ARGV = @_;
636        my $jid;
637        my $muc;
638        my $m = BarnOwl::getcurmsg();
639        if ( $m && $m->is_jabber && $m->{jtype} eq 'groupchat' ) {
640            $muc = $m->{room};
641            $jid = $m->{to};
642        }
643
644        my $getopt = Getopt::Long::Parser->new;
645        $getopt->configure('pass_through');
646        $getopt->getoptions( 'account=s' => \$jid );
647        $jid ||= defaultJID();
648        if ($jid) {
649            $jid = resolveConnectedJID($jid);
650            return unless $jid;
651        }
652        else {
653            BarnOwl::error('You must specify an account with -a {jid}');
654        }
655        return $func->( $jid, $muc, @ARGV );
656    }
657}
658
659sub jmuc_join {
660    my ( $jid, $muc, @args ) = @_;
661    local @ARGV = @args;
662    my $password;
663    GetOptions( 'password=s' => \$password );
664
665    $muc = shift @ARGV
666      or die("Usage: jmuc join MUC [-p password] [-a account]");
667
668    $conn->getConnectionFromJID($jid)->MUCJoin(Jid      => $muc,
669                                                  Password => $password,
670                                                  History  => {
671                                                      MaxChars => 0
672                                                     });
673    return;
674}
675
676sub jmuc_part {
677    my ( $jid, $muc, @args ) = @_;
678
679    $muc = shift @args if scalar @args;
680    die("Usage: jmuc part MUC [-a account]") unless $muc;
681
682    $conn->getConnectionFromJID($jid)->MUCLeave(JID => $muc);
683    queue_admin_msg("$jid has left $muc.");
684}
685
686sub jmuc_invite {
687    my ( $jid, $muc, @args ) = @_;
688
689    my $invite_jid = shift @args;
690    $muc = shift @args if scalar @args;
691
692    die('Usage: jmuc invite JID [muc] [-a account]')
693      unless $muc && $invite_jid;
694
695    my $message = Net::Jabber::Message->new();
696    $message->SetTo($muc);
697    my $x = $message->NewChild('http://jabber.org/protocol/muc#user');
698    $x->AddInvite();
699    $x->GetInvite()->SetTo($invite_jid);
700    $conn->getConnectionFromJID($jid)->Send($message);
701    queue_admin_msg("$jid has invited $invite_jid to $muc.");
702}
703
704sub jmuc_configure {
705    my ( $jid, $muc, @args ) = @_;
706    $muc = shift @args if scalar @args;
707    die("Usage: jmuc configure [muc]") unless $muc;
708    my $iq = Net::Jabber::IQ->new();
709    $iq->SetTo($muc);
710    $iq->SetType('set');
711    my $query = $iq->NewQuery("http://jabber.org/protocol/muc#owner");
712    my $x     = $query->NewChild("jabber:x:data");
713    $x->SetType('submit');
714
715    $conn->getConnectionFromJID($jid)->Send($iq);
716    queue_admin_msg("Accepted default instant configuration for $muc");
717}
718
719sub jmuc_presence {
720    my ( $jid, $muc, @args ) = @_;
721
722    $muc = shift @args if scalar @args;
723    die("Usage: jmuc presence MUC") unless $muc;
724
725    my $m = $conn->getConnectionFromJID($jid)->FindMUC(jid => $muc);
726    die("No such muc: $muc") unless $m;
727
728    my @jids = $m->Presence();
729    BarnOwl::popless_ztext("JIDs present in " . $m->BaseJID . "\n\t" .
730                           join("\n\t", map {$_->GetResource}@jids) . "\n");
731}
732
733
734#XXX TODO: Consider merging this with jmuc and selecting off the first two args.
735sub cmd_jroster {
736    die "You are not logged in to Jabber" unless $conn->connected();
737    my $ocmd = shift;
738    my $cmd  = shift;
739    if ( !$cmd ) {
740
741        #XXX TODO: Write general usage for jroster command.
742        return;
743    }
744
745    my %jroster_commands = (
746        sub      => \&jroster_sub,
747        unsub    => \&jroster_unsub,
748        add      => \&jroster_add,
749        remove   => \&jroster_remove,
750        auth     => \&jroster_auth,
751        deauth   => \&jroster_deauth
752    );
753    my $func = $jroster_commands{$cmd};
754    if ( !$func ) {
755        BarnOwl::error("jroster: Unknown command: $cmd");
756        return;
757    }
758
759    {
760        local @ARGV = @_;
761        my $jid;
762        my $name;
763        my @groups;
764        my $purgeGroups;
765        my $getopt = Getopt::Long::Parser->new;
766        $getopt->configure('pass_through');
767        $getopt->getoptions(
768            'account=s' => \$jid,
769            'group=s' => \@groups,
770            'purgegroups' => \$purgeGroups,
771            'name=s' => \$name
772        );
773        $jid ||= defaultJID();
774        if ($jid) {
775            $jid = resolveConnectedJID($jid);
776            return unless $jid;
777        }
778        else {
779            BarnOwl::error('You must specify an account with -a {jid}');
780        }
781        return $func->( $jid, $name, \@groups, $purgeGroups,  @ARGV );
782    }
783}
784
785sub jroster_sub {
786    my $jid = shift;
787    my $name = shift;
788    my @groups = @{ shift() };
789    my $purgeGroups = shift;
790    my $baseJid = baseJID($jid);
791
792    my $roster = $conn->getRosterFromJID($jid);
793
794    # Adding lots of users with the same name is a bad idea.
795    $name = "" unless (1 == scalar(@ARGV));
796
797    my $p = new Net::XMPP::Presence;
798    $p->SetType('subscribe');
799
800    foreach my $to (@ARGV) {
801        jroster_add($jid, $name, \@groups, $purgeGroups, ($to)) unless ($roster->exists($to));
802
803        $p->SetTo($to);
804        $conn->getConnectionFromJID($jid)->Send($p);
805        queue_admin_msg("You ($baseJid) have requested a subscription to ($to)'s presence.");
806    }
807}
808
809sub jroster_unsub {
810    my $jid = shift;
811    my $name = shift;
812    my @groups = @{ shift() };
813    my $purgeGroups = shift;
814    my $baseJid = baseJID($jid);
815
816    my $p = new Net::XMPP::Presence;
817    $p->SetType('unsubscribe');
818    foreach my $to (@ARGV) {
819        $p->SetTo($to);
820        $conn->getConnectionFromJID($jid)->Send($p);
821        queue_admin_msg("You ($baseJid) have unsubscribed from ($to)'s presence.");
822    }
823}
824
825sub jroster_add {
826    my $jid = shift;
827    my $name = shift;
828    my @groups = @{ shift() };
829    my $purgeGroups = shift;
830    my $baseJid = baseJID($jid);
831
832    my $roster = $conn->getRosterFromJID($jid);
833
834    # Adding lots of users with the same name is a bad idea.
835    $name = "" unless (1 == scalar(@ARGV));
836
837    foreach my $to (@ARGV) {
838        my %jq  = $roster->query($to);
839        my $iq = new Net::XMPP::IQ;
840        $iq->SetType('set');
841        my $item = new XML::Stream::Node('item');
842        $iq->NewChild('jabber:iq:roster')->AddChild($item);
843
844        my %allGroups = ();
845
846        foreach my $g (@groups) {
847            $allGroups{$g} = $g;
848        }
849
850        unless ($purgeGroups) {
851            foreach my $g (@{$jq{groups}}) {
852                $allGroups{$g} = $g;
853            }
854        }
855
856        foreach my $g (keys %allGroups) {
857            $item->add_child('group')->add_cdata($g);
858        }
859
860        $item->put_attrib(jid => $to);
861        $item->put_attrib(name => $name) if $name;
862        $conn->getConnectionFromJID($jid)->Send($iq);
863        my $msg = "$baseJid: "
864          . ($name ? "$name ($to)" : "($to)")
865          . " is on your roster in the following groups: { "
866          . join(" , ", keys %allGroups)
867          . " }";
868        queue_admin_msg($msg);
869    }
870}
871
872sub jroster_remove {
873    my $jid = shift;
874    my $name = shift;
875    my @groups = @{ shift() };
876    my $purgeGroups = shift;
877    my $baseJid = baseJID($jid);
878
879    my $iq = new Net::XMPP::IQ;
880    $iq->SetType('set');
881    my $item = new XML::Stream::Node('item');
882    $iq->NewChild('jabber:iq:roster')->AddChild($item);
883    $item->put_attrib(subscription=> 'remove');
884    foreach my $to (@ARGV) {
885        $item->put_attrib(jid => $to);
886        $conn->getConnectionFromJID($jid)->Send($iq);
887        queue_admin_msg("You ($baseJid) have removed ($to) from your roster.");
888    }
889}
890
891sub jroster_auth {
892    my $jid = shift;
893    my $name = shift;
894    my @groups = @{ shift() };
895    my $purgeGroups = shift;
896    my $baseJid = baseJID($jid);
897
898    my $p = new Net::XMPP::Presence;
899    $p->SetType('subscribed');
900    foreach my $to (@ARGV) {
901        $p->SetTo($to);
902        $conn->getConnectionFromJID($jid)->Send($p);
903        queue_admin_msg("($to) has been subscribed to your ($baseJid) presence.");
904    }
905}
906
907sub jroster_deauth {
908    my $jid = shift;
909    my $name = shift;
910    my @groups = @{ shift() };
911    my $purgeGroups = shift;
912    my $baseJid = baseJID($jid);
913
914    my $p = new Net::XMPP::Presence;
915    $p->SetType('unsubscribed');
916    foreach my $to (@ARGV) {
917        $p->SetTo($to);
918        $conn->getConnectionFromJID($jid)->Send($p);
919        queue_admin_msg("($to) has been unsubscribed from your ($baseJid) presence.");
920    }
921}
922
923################################################################################
924### Owl Callbacks
925sub process_owl_jwrite {
926    my $body = shift;
927
928    my $j = new Net::XMPP::Message;
929    $body =~ s/\n\z//;
930    $j->SetMessage(
931        to   => $vars{jwrite}{to},
932        from => $vars{jwrite}{from},
933        type => $vars{jwrite}{type},
934        body => $body
935    );
936
937    $j->SetThread( $vars{jwrite}{thread} )   if ( $vars{jwrite}{thread} );
938    $j->SetSubject( $vars{jwrite}{subject} ) if ( $vars{jwrite}{subject} );
939
940    my $m = j2o( $j, { direction => 'out' } );
941    if ( $vars{jwrite}{type} ne 'groupchat' && BarnOwl::getvar('displayoutgoing') eq 'on') {
942        BarnOwl::queue_message($m);
943    }
944
945    $j->RemoveFrom(); # Kludge to get around gtalk's random bits after the resouce.
946    if ($vars{jwrite}{sid} && $conn->sidExists( $vars{jwrite}{sid} )) {
947        $conn->getConnectionFromSid($vars{jwrite}{sid})->Send($j);
948    }
949    else {
950        $conn->getConnectionFromJID($vars{jwrite}{from})->Send($j);
951    }
952
953    delete $vars{jwrite};
954    BarnOwl::message("");   # Kludge to make the ``type your message...'' message go away
955}
956
957### XMPP Callbacks
958
959sub process_incoming_chat_message {
960    my ( $sid, $j ) = @_;
961    BarnOwl::queue_message( j2o( $j, { direction => 'in',
962                                   sid => $sid } ) );
963}
964
965sub process_incoming_error_message {
966    my ( $sid, $j ) = @_;
967    my %jhash = j2hash( $j, { direction => 'in',
968                              sid => $sid } );
969    $jhash{type} = 'admin';
970    BarnOwl::queue_message( BarnOwl::Message->new(%jhash) );
971}
972
973sub process_incoming_groupchat_message {
974    my ( $sid, $j ) = @_;
975
976    # HACK IN PROGRESS (ignoring delayed messages)
977    return if ( $j->DefinedX('jabber:x:delay') && $j->GetX('jabber:x:delay') );
978    BarnOwl::queue_message( j2o( $j, { direction => 'in',
979                                   sid => $sid } ) );
980}
981
982sub process_incoming_headline_message {
983    my ( $sid, $j ) = @_;
984    BarnOwl::queue_message( j2o( $j, { direction => 'in',
985                                   sid => $sid } ) );
986}
987
988sub process_incoming_normal_message {
989    my ( $sid, $j ) = @_;
990    my %jhash = j2hash( $j, { direction => 'in',
991                              sid => $sid } );
992
993    # XXX TODO: handle things such as MUC invites here.
994
995    #    if ($j->HasX('http://jabber.org/protocol/muc#user'))
996    #    {
997    #   my $x = $j->GetX('http://jabber.org/protocol/muc#user');
998    #   if ($x->HasChild('invite'))
999    #   {
1000    #       $props
1001    #   }
1002    #    }
1003    #
1004    BarnOwl::queue_message( BarnOwl::Message->new(%jhash) );
1005}
1006
1007sub process_muc_presence {
1008    my ( $sid, $p ) = @_;
1009    return unless ( $p->HasX('http://jabber.org/protocol/muc#user') );
1010}
1011
1012
1013sub process_presence_available {
1014    my ( $sid, $p ) = @_;
1015    my $from = $p->GetFrom();
1016    my $to = $p->GetTo();
1017    my $type = $p->GetType();
1018    my %props = (
1019        to => $to,
1020        from => $from,
1021        recipient => $to,
1022        sender => $from,
1023        type => 'jabber',
1024        jtype => $p->GetType(),
1025        status => $p->GetStatus(),
1026        show => $p->GetShow(),
1027        xml => $p->GetXML(),
1028        direction => 'in');
1029
1030    if ($type eq '' || $type eq 'available') {
1031        $props{body} = "$from is now online. ";
1032        $props{loginout} = 'login';
1033    }
1034    else {
1035        $props{body} = "$from is now offline. ";
1036        $props{loginout} = 'logout';
1037    }
1038    $props{replysendercmd} = $props{replycmd} = "jwrite $from -i $sid";
1039    if(BarnOwl::getvar('debug') eq 'on') {
1040        BarnOwl::queue_message(BarnOwl::Message->new(%props));
1041    }
1042}
1043
1044sub process_presence_subscribe {
1045    my ( $sid, $p ) = @_;
1046    my $from = $p->GetFrom();
1047    my $to = $p->GetTo();
1048    my %props = (
1049        to => $to,
1050        from => $from,
1051        xml => $p->GetXML(),
1052        type => 'admin',
1053        adminheader => 'Jabber presence: subscribe',
1054        direction => 'in');
1055
1056    $props{body} = "Allow user ($from) to subscribe to your ($to) presence?\n" .
1057                   "(Answer with the `yes' or `no' commands)";
1058    $props{yescommand} = "jroster auth $from -a $to";
1059    $props{nocommand} = "jroster deauth $from -a $to";
1060    $props{question} = "true";
1061    BarnOwl::queue_message(BarnOwl::Message->new(%props));
1062}
1063
1064sub process_presence_unsubscribe {
1065    my ( $sid, $p ) = @_;
1066    my $from = $p->GetFrom();
1067    my $to = $p->GetTo();
1068    my %props = (
1069        to => $to,
1070        from => $from,
1071        xml => $p->GetXML(),
1072        type => 'admin',
1073        adminheader => 'Jabber presence: unsubscribe',
1074        direction => 'in');
1075
1076    $props{body} = "The user ($from) has been unsubscribed from your ($to) presence.\n";
1077    BarnOwl::queue_message(BarnOwl::Message->new(%props));
1078
1079    # Find a connection to reply with.
1080    foreach my $jid ($conn->getJids()) {
1081        my $cJid = new Net::XMPP::JID;
1082        $cJid->SetJID($jid);
1083        if ($to eq $cJid->GetJID('base') ||
1084            $to eq $cJid->GetJID('full')) {
1085            my $reply = $p->Reply(type=>"unsubscribed");
1086            $conn->getConnectionFromJID($jid)->Send($reply);
1087            return;
1088        }
1089    }
1090}
1091
1092sub process_presence_subscribed {
1093    my ( $sid, $p ) = @_;
1094    queue_admin_msg("ignoring:".$p->GetXML());
1095    # RFC 3921 says we should respond to this with a "subscribe"
1096    # but this causes a flood of sub/sub'd presence packets with
1097    # some servers, so we won't. We may want to detect this condition
1098    # later, and have per-server settings.
1099    return;
1100}
1101
1102sub process_presence_unsubscribed {
1103    my ( $sid, $p ) = @_;
1104    queue_admin_msg("ignoring:".$p->GetXML());
1105    # RFC 3921 says we should respond to this with a "subscribe"
1106    # but this causes a flood of unsub/unsub'd presence packets with
1107    # some servers, so we won't. We may want to detect this condition
1108    # later, and have per-server settings.
1109    return;
1110}
1111
1112sub process_presence_error {
1113    my ( $sid, $p ) = @_;
1114    my $code = $p->GetErrorCode();
1115    my $error = $p->GetError();
1116    BarnOwl::error("Jabber: $code $error");
1117}
1118
1119
1120### Helper functions
1121
1122sub j2hash {
1123    my $j   = shift;
1124    my %initProps = %{ shift() };
1125
1126    my $dir = 'none';
1127    my %props = ( type => 'jabber' );
1128
1129    foreach my $k (keys %initProps) {
1130        $dir = $initProps{$k} if ($k eq 'direction');
1131        $props{$k} = $initProps{$k};
1132    }
1133
1134    my $jtype = $props{jtype} = $j->GetType();
1135    my $from = $j->GetFrom('jid');
1136    my $to   = $j->GetTo('jid');
1137
1138    $props{from} = $from->GetJID('full');
1139    $props{to}   = $to->GetJID('full');
1140
1141    $props{recipient}  = $to->GetJID('base');
1142    $props{sender}     = $from->GetJID('base');
1143    $props{subject}    = $j->GetSubject() if ( $j->DefinedSubject() );
1144    $props{thread}     = $j->GetThread() if ( $j->DefinedThread() );
1145    $props{body}       = $j->GetBody() if ( $j->DefinedBody() );
1146    $props{error}      = $j->GetError() if ( $j->DefinedError() );
1147    $props{error_code} = $j->GetErrorCode() if ( $j->DefinedErrorCode() );
1148    $props{xml}        = $j->GetXML();
1149
1150    if ( $jtype eq 'chat' ) {
1151        $props{replycmd} =
1152          "jwrite " . ( ( $dir eq 'in' ) ? $props{from} : $props{to} );
1153        $props{replycmd} .=
1154          " -a " . ( ( $dir eq 'out' ) ? $props{from} : $props{to} );
1155        $props{private} = 1;
1156    }
1157    elsif ( $jtype eq 'groupchat' ) {
1158        my $nick = $props{nick} = $from->GetResource();
1159        my $room = $props{room} = $from->GetJID('base');
1160        $props{replycmd} = "jwrite $room";
1161        $props{replycmd} .=
1162          " -a " . ( ( $dir eq 'out' ) ? $props{from} : $props{to} );
1163
1164        $props{sender} = $nick || $room;
1165        $props{recipient} = $room;
1166
1167        if ( $props{subject} && !$props{body} ) {
1168            $props{body} =
1169              '[' . $nick . " has set the topic to: " . $props{subject} . "]";
1170        }
1171    }
1172    elsif ( $jtype eq 'normal' ) {
1173        $props{replycmd}  = undef;
1174        $props{private} = 1;
1175    }
1176    elsif ( $jtype eq 'headline' ) {
1177        $props{replycmd} = undef;
1178    }
1179    elsif ( $jtype eq 'error' ) {
1180        $props{replycmd} = undef;
1181        $props{body}     = "Error "
1182          . $props{error_code}
1183          . " sending to "
1184          . $props{from} . "\n"
1185          . $props{error};
1186    }
1187
1188    $props{replysendercmd} = $props{replycmd};
1189    return %props;
1190}
1191
1192sub j2o {
1193    return BarnOwl::Message->new( j2hash(@_) );
1194}
1195
1196sub queue_admin_msg {
1197    my $err = shift;
1198    my $m   = BarnOwl::Message->new(
1199        type      => 'admin',
1200        direction => 'none',
1201        body      => $err
1202    );
1203    BarnOwl::queue_message($m);
1204}
1205
1206sub boldify($) {
1207    my $str = shift;
1208
1209    return '@b(' . $str . ')' if ( $str !~ /\)/ );
1210    return '@b<' . $str . '>' if ( $str !~ /\>/ );
1211    return '@b{' . $str . '}' if ( $str !~ /\}/ );
1212    return '@b[' . $str . ']' if ( $str !~ /\]/ );
1213
1214    my $txt = "$str";
1215    $txt =~ s{[)]}{)\@b[)]\@b(}g;
1216    return '@b(' . $txt . ')';
1217}
1218
1219sub getServerFromJID {
1220    my $jid = shift;
1221    my $res = new Net::DNS::Resolver;
1222    my $packet =
1223      $res->search( '_xmpp-client._tcp.' . $jid->GetServer(), 'srv' );
1224
1225    if ($packet)    # Got srv record.
1226    {
1227        my @answer = $packet->answer;
1228        return $answer[0]{target}, $answer[0]{port};
1229    }
1230
1231    return $jid->GetServer(), 5222;
1232}
1233
1234sub defaultJID {
1235    return ( $conn->getJids() )[0] if ( $conn->connected() == 1 );
1236    return;
1237}
1238
1239sub baseJID {
1240    my $givenJidStr = shift;
1241    my $givenJid    = new Net::XMPP::JID;
1242    $givenJid->SetJID($givenJidStr);
1243    return $givenJid->GetJID('base');
1244}
1245
1246sub resolveConnectedJID {
1247    my $givenJidStr = shift;
1248    my $givenJid    = new Net::XMPP::JID;
1249    $givenJid->SetJID($givenJidStr);
1250
1251    # Account fully specified.
1252    if ( $givenJid->GetResource() ) {
1253        # Specified account exists
1254        return $givenJidStr if ($conn->jidExists($givenJidStr) );
1255        die("Invalid account: $givenJidStr");
1256    }
1257
1258    # Disambiguate.
1259    else {
1260        my $matchingJid = "";
1261        my $errStr =
1262          "Ambiguous account reference. Please specify a resource.\n";
1263        my $ambiguous = 0;
1264
1265        foreach my $jid ( $conn->getJids() ) {
1266            my $cJid = new Net::XMPP::JID;
1267            $cJid->SetJID($jid);
1268            if ( $givenJidStr eq $cJid->GetJID('base') ) {
1269                $ambiguous = 1 if ( $matchingJid ne "" );
1270                $matchingJid = $jid;
1271                $errStr .= "\t$jid\n";
1272            }
1273        }
1274
1275        # Need further disambiguation.
1276        if ($ambiguous) {
1277            die($errStr);
1278        }
1279
1280        # Not one of ours.
1281        elsif ( $matchingJid eq "" ) {
1282            die("Invalid account: $givenJidStr");
1283        }
1284
1285        # It's this one.
1286        else {
1287            return $matchingJid;
1288        }
1289    }
1290    return "";
1291}
1292
1293sub resolveDestJID {
1294    my ($to, $from) = @_;
1295    return $to if $to =~ /@/;
1296    my $jid = Net::Jabber::JID->new($to);
1297
1298    my $roster = $conn->getRosterFromJID($from);
1299    my @jids = $roster->jids('all');
1300    for my $j (@jids) {
1301        if($roster->query($j, 'name') eq $to) {
1302            return $j->GetJID('full');
1303        }
1304    }
1305
1306    return undef;
1307}
1308
1309sub resolveType {
1310    my $to = shift;
1311    my $from = shift;
1312    my @mucs = $conn->getConnectionFromJID($from)->MUCs;
1313    if(grep {$_->BaseJID eq $to } @mucs) {
1314        return 'groupchat';
1315    } else {
1316        return 'chat';
1317    }
1318}
1319
1320sub guess_jwrite {
1321    # Heuristically guess what jids a jwrite was meant to be going to/from
1322    my ($from, $to) = (@_);
1323    my ($from_jid, $to_jid);
1324    if($from) {
1325        $from_jid = resolveConnectedJID($from);
1326        die("Unable to resolve account $from") unless $from_jid;
1327        $to_jid = resolveDestJID($to, $from_jid);
1328    } elsif($to =~ /@/) {
1329        $to_jid = $to;
1330        $from_jid = defaultJID();
1331        die("You must specify an account with -a") unless $from_jid;
1332    } else {
1333        for my $f ($conn->getJids) {
1334            $to_jid = resolveDestJID($to, $f);
1335            if(defined($to_jid)) {
1336                $from_jid = $f;
1337            }
1338        }
1339        die("Unable to resolve JID $to") unless $to_jid;
1340    }
1341
1342    my $type = resolveType($to_jid, $from_jid);
1343    return ($from_jid, $to_jid, $type);
1344}
1345
1346#####################################################################
1347#####################################################################
1348
1349package BarnOwl::Message::Jabber;
1350
1351our @ISA = qw( BarnOwl::Message );
1352
1353sub jtype { shift->{jtype} };
1354sub from { shift->{from} };
1355sub to { shift->{to} };
1356sub room { shift->{room} };
1357
1358sub smartfilter {
1359    my $self = shift;
1360    my $inst = shift;
1361
1362    my ($filter, $ftext);
1363
1364    if($self->jtype eq 'chat') {
1365        my $user;
1366        if($self->direction eq 'in') {
1367            $user = $self->from;
1368        } else {
1369            $user = $self->to;
1370        }
1371        $user = Net::Jabber::JID->new($user)->GetJID($inst ? 'full' : 'base');
1372        $filter = "jabber-user-$user";
1373        $ftext = qq{type ^jabber\$ and ( ( direction ^in\$ and from ^$user ) } .
1374                 qq{or ( direction ^out\$ and to ^$user ) ) };
1375        BarnOwl::filter("$filter $ftext");
1376        return $filter;
1377    } elsif ($self->jtype eq 'groupchat') {
1378        my $room = $self->room;
1379        $filter = "jabber-room-$room";
1380        $ftext = qq{type ^jabber\$ and room ^$room\$};
1381        BarnOwl::filter("$filter $ftext");
1382        return $filter;
1383    }
1384}
1385
13861;
Note: See TracBrowser for help on using the repository browser.