source: perl/modules/Jabber/lib/BarnOwl/Module/Jabber.pm @ 5f3168a

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