source: perl/modules/IRC/lib/BarnOwl/Module/IRC.pm @ 919535f

barnowl_perlaimdebianrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 919535f was 919535f, checked in by Geoffrey Thomas <geofft@mit.edu>, 13 years ago
Implement /me for outgoing IRC messages
  • Property mode set to 100644
File size: 8.7 KB
RevLine 
[b38b0b2]1use strict;
2use warnings;
3
4package BarnOwl::Module::IRC;
5
6=head1 NAME
7
[2c40dc0]8BarnOwl::Module::IRC
[b38b0b2]9
10=head1 DESCRIPTION
11
[2c40dc0]12This module implements IRC support for barnowl.
[b38b0b2]13
14=cut
15
16use BarnOwl;
17use BarnOwl::Hooks;
18use BarnOwl::Message::IRC;
[380b1ab]19use BarnOwl::Module::IRC::Connection qw(is_private);
[b38b0b2]20
21use Net::IRC;
22use Getopt::Long;
23
[2c40dc0]24our $VERSION = 0.02;
[b38b0b2]25
26our $irc;
27
28# Hash alias -> BarnOwl::Module::IRC::Connection object
29our %ircnets;
[fe8cad8]30our %channels;
[b38b0b2]31
32sub startup {
[b10f340]33    BarnOwl::new_variable_string('irc:nick', {
34        default     => $ENV{USER},
35        summary     => 'The default IRC nickname',
36        description => 'By default, irc-connect will use this nick '  .
37        'when connecting to a new server. See :help irc-connect for ' .
38        'more information.'
39       });
40
41    BarnOwl::new_variable_string('irc:user', {
42        default => $ENV{USER},
43        summary => 'The IRC "username" field'
44       });
45        BarnOwl::new_variable_string('irc:name', {
46        default => "",
47        summary     => 'A short name field for IRC',
48        description => 'A short (maybe 60 or so chars) piece of text, ' .
49        'originally intended to display your real name, which people '  .
50        'often use for pithy quotes and URLs.'
51       });
52   
53    BarnOwl::new_variable_bool('irc:spew', {
54        default     => 0,
55        summary     => 'Show unhandled IRC events',
56        description => 'If set, display all unrecognized IRC events as ' .
57        'admin messages. Intended for debugging and development use only '
58       });
59   
[b38b0b2]60    register_commands();
61    register_handlers();
62    BarnOwl::filter('irc type ^IRC$');
63}
64
65sub shutdown {
66    for my $conn (values %ircnets) {
[ba2ca66]67        $conn->conn->disconnect();
[b38b0b2]68    }
69}
70
[9c7a701]71#sub mainloop_hook {
72#    return unless defined $irc;
73#    eval {
74#        $irc->do_one_loop();
75#    };
76#    return;
77#}
78
79sub OwlProcess {
[b38b0b2]80    return unless defined $irc;
81    eval {
82        $irc->do_one_loop();
83    };
84    return;
85}
86
[9c7a701]87
[b38b0b2]88sub register_handlers {
89    if(!$irc) {
90        $irc = Net::IRC->new;
91        $irc->timeout(0);
92    }
93}
94
95sub register_commands {
[b0c8011]96    BarnOwl::new_command('irc-connect' => \&cmd_connect,
97                       {
98                           summary      => 'Connect to an IRC server',
99                           usage        => 'irc-connect [-a ALIAS ] [-s] [-p PASSWORD] [-n NICK] SERVER [port]',
100                           description  =>
101
102                           "Connect to an IRC server. Supported options are\n\n" .
103                           "-a <alias>          Define an alias for this server\n" .
104                           "-s                  Use SSL\n" .
105                           "-p <password>       Specify the password to use\n" .
106                           "-n <nick>           Use a non-default nick"
107                       });
[b38b0b2]108    BarnOwl::new_command('irc-disconnect' => \&cmd_disconnect);
[b0c8011]109    BarnOwl::new_command('irc-msg'        => \&cmd_msg);
110    BarnOwl::new_command('irc-join'       => \&cmd_join);
111    BarnOwl::new_command('irc-part'       => \&cmd_part);
112    BarnOwl::new_command('irc-nick'       => \&cmd_nick);
113    BarnOwl::new_command('irc-names'      => \&cmd_names);
114    BarnOwl::new_command('irc-whois'      => \&cmd_whois);
[56e72d5]115    BarnOwl::new_command('irc-motd'       => \&cmd_motd);
[b38b0b2]116}
117
118$BarnOwl::Hooks::startup->add(\&startup);
119$BarnOwl::Hooks::shutdown->add(\&shutdown);
[9c7a701]120#$BarnOwl::Hooks::mainLoop->add(\&mainloop_hook);
[b38b0b2]121
122################################################################################
123######################## Owl command handlers ##################################
124################################################################################
125
126sub cmd_connect {
127    my $cmd = shift;
128
[2c40dc0]129    my $nick = BarnOwl::getvar('irc:nick');
130    my $username = BarnOwl::getvar('irc:user');
131    my $ircname = BarnOwl::getvar('irc:name');
[b38b0b2]132    my $host;
133    my $port;
134    my $alias;
135    my $ssl;
136    my $password = undef;
137
138    {
139        local @ARGV = @_;
140        GetOptions(
141            "alias=s"    => \$alias,
142            "ssl"        => \$ssl,
[2c40dc0]143            "password=s" => \$password,
[b10f340]144            "nick=s"     => \$nick,
[2c40dc0]145        );
[b38b0b2]146        $host = shift @ARGV or die("Usage: $cmd HOST\n");
147        if(!$alias) {
[b0c8011]148            if($host =~ /^(?:irc[.])?(\w+)[.]\w+$/) {
149                $alias = $1;
150            } else {
151                $alias = $host;
152            }
[b38b0b2]153        }
[b0c8011]154        $port = shift @ARGV || 6667;
[b38b0b2]155        $ssl ||= 0;
156    }
157
[b0c8011]158    if(exists $ircnets{$alias}) {
159        die("Already connected to a server with alias '$alias'. Either disconnect or specify an alias with -a.\n");
160    }
161
[b38b0b2]162    my $conn = BarnOwl::Module::IRC::Connection->new($irc, $alias,
163        Nick      => $nick,
164        Server    => $host,
165        Port      => $port,
166        Username  => $username,
167        Ircname   => $ircname,
168        Port      => $port,
169        Password  => $password,
170        SSL       => $ssl
171       );
172
[cab045b]173    if ($conn->conn->connected) {
[5ff830a]174        BarnOwl::admin_message("IRC", "Connected to $alias as $nick");
175        $ircnets{$alias} = $conn;
[9c7a701]176        my $fd = $conn->getSocket()->fileno();
177        BarnOwl::add_dispatch($fd, \&OwlProcess);
178        $conn->{FD} = $fd;
[5ff830a]179    } else {
180        die("IRC::Connection->connect failed: $!");
181    }
182
[b38b0b2]183    return;
184}
185
186sub cmd_disconnect {
187    my $cmd = shift;
188    my $conn = get_connection(\@_);
[ba2ca66]189    $conn->conn->disconnect;
[b38b0b2]190    delete $ircnets{$conn->alias};
191}
192
193sub cmd_msg {
194    my $cmd = shift;
195    my $conn = get_connection(\@_);
196    my $to = shift or die("Usage: $cmd NICK\n");
[2c40dc0]197    # handle multiple recipients?
[b38b0b2]198    if(@_) {
199        process_msg($conn, $to, join(" ", @_));
200    } else {
[3c5fe43]201        BarnOwl::start_edit_win("/msg -a " . $conn->alias . " $to", sub {process_msg($conn, $to, @_)});
[b38b0b2]202    }
203}
204
205sub process_msg {
206    my $conn = shift;
207    my $to = shift;
208    my $body = shift;
209    # Strip whitespace. In the future -- send one message/line?
210    $body =~ tr/\n\r/  /;
[919535f]211    if ($body =~ /^\/me (.*)/) {
212        $conn->conn->me($to, $1);
213        $body = BarnOwl::Style::boldify($conn->nick.' '.$1);
214    } else {
215        $conn->conn->privmsg($to, $body);
216    }
[b38b0b2]217    my $msg = BarnOwl::Message->new(
218        type        => 'IRC',
[6858d2d]219        direction   => is_private($to) ? 'out' : 'in',
[b38b0b2]220        server      => $conn->server,
221        network     => $conn->alias,
222        recipient   => $to,
223        body        => $body,
224        sender      => $conn->nick,
[2c40dc0]225        is_private($to) ?
[0e52069]226          (isprivate  => 'true') : (channel => $to),
[3c5fe43]227        replycmd    => "irc-msg -a " . $conn->alias . " $to",
228        replysendercmd => "irc-msg -a " . $conn->alias . " $to"
[b38b0b2]229       );
230    BarnOwl::queue_message($msg);
231}
232
[2c40dc0]233sub cmd_join {
234    my $cmd = shift;
235    my $conn = get_connection(\@_);
236    my $chan = shift or die("Usage: $cmd channel\n");
[fe8cad8]237    $channels{$chan} ||= [];
238    push @{$channels{$chan}}, $conn;
[ba2ca66]239    $conn->conn->join($chan);
[2c40dc0]240}
[b38b0b2]241
[6858d2d]242sub cmd_part {
243    my $cmd = shift;
244    my $conn = get_connection(\@_);
[b0c8011]245    my $chan = get_channel(\@_) || die("Usage: $cmd <channel>\n");
[fe8cad8]246    $channels{$chan} = [grep {$_ ne $conn} @{$channels{$chan} || []}];
[ba2ca66]247    $conn->conn->part($chan);
[6858d2d]248}
249
[6286f26]250sub cmd_nick {
251    my $cmd = shift;
252    my $conn = get_connection(\@_);
[b0c8011]253    my $nick = shift or die("Usage: $cmd <new nick>\n");
[ba2ca66]254    $conn->conn->nick($nick);
[6286f26]255}
256
[6858d2d]257sub cmd_names {
258    my $cmd = shift;
259    my $conn = get_connection(\@_);
[b0c8011]260    my $chan = get_channel(\@_) || die("Usage: $cmd <channel>\n");
[ba2ca66]261    $conn->conn->names($chan);
[6858d2d]262}
263
[b0c8011]264sub cmd_whois {
265    my $cmd = shift;
266    my $conn = get_connection(\@_);
267    my $who = shift || die("Usage: $cmd <user>\n");
[ba2ca66]268    $conn->conn->whois($who);
[b0c8011]269}
270
[56e72d5]271sub cmd_motd {
272    my $cmd = shift;
273    my $conn = get_connection(\@_);
[ba2ca66]274    $conn->conn->motd;
[56e72d5]275}
276
[b38b0b2]277################################################################################
278########################### Utilities/Helpers ##################################
279################################################################################
280
281sub get_connection {
282    my $args = shift;
283    if(scalar @$args >= 2 && $args->[0] eq '-a') {
284        shift @$args;
285        return get_connection_by_alias(shift @$args);
286    }
[fe8cad8]287    my $channel = $args->[-1];
[56e72d5]288    if (defined($channel) && $channel =~ /^#/
289        and $channels{$channel} and @{$channels{$channel}} == 1) {
[fe8cad8]290        return $channels{$channel}[0];
291    }
[b38b0b2]292    my $m = BarnOwl::getcurmsg();
293    if($m && $m->type eq 'IRC') {
294        return get_connection_by_alias($m->network);
295    }
296    if(scalar keys %ircnets == 1) {
297        return [values(%ircnets)]->[0];
298    }
299    die("You must specify a network with -a\n");
300}
301
[6858d2d]302sub get_channel {
303    my $args = shift;
304    if(scalar @$args) {
305        return shift @$args;
306    }
307    my $m = BarnOwl::getcurmsg();
308    if($m && $m->type eq 'IRC') {
309        return $m->channel if !$m->is_private;
310    }
311    return undef;
312}
313
[b38b0b2]314sub get_connection_by_alias {
[2c40dc0]315    my $key = shift;
316    die("No such ircnet: $key\n") unless exists $ircnets{$key};
[b38b0b2]317    return $ircnets{$key};
318}
319
3201;
Note: See TracBrowser for help on using the repository browser.