source: perl/modules/IRC/lib/BarnOwl/Module/IRC.pm @ 33db995

debianrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 33db995 was 33db995, checked in by Nelson Elhage <nelhage@mit.edu>, 12 years ago
Fix cmd_disconnect (accidentally broken in 330c55a8).
  • Property mode set to 100644
File size: 10.8 KB
Line 
1use strict;
2use warnings;
3
4package BarnOwl::Module::IRC;
5
6=head1 NAME
7
8BarnOwl::Module::IRC
9
10=head1 DESCRIPTION
11
12This module implements IRC support for barnowl.
13
14=cut
15
16use BarnOwl;
17use BarnOwl::Hooks;
18use BarnOwl::Message::IRC;
19use BarnOwl::Module::IRC::Connection qw(is_private);
20
21use Net::IRC;
22use Getopt::Long;
23
24our $VERSION = 0.02;
25
26our $irc;
27
28# Hash alias -> BarnOwl::Module::IRC::Connection object
29our %ircnets;
30our %channels;
31
32sub startup {
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   
60    register_commands();
61    register_handlers();
62    BarnOwl::filter('irc type ^IRC$');
63}
64
65sub shutdown {
66    for my $conn (values %ircnets) {
67        $conn->conn->disconnect();
68    }
69}
70
71#sub mainloop_hook {
72#    return unless defined $irc;
73#    eval {
74#        $irc->do_one_loop();
75#    };
76#    return;
77#}
78
79sub OwlProcess {
80    return unless defined $irc;
81    eval {
82        $irc->do_one_loop();
83    };
84    return;
85}
86
87
88sub register_handlers {
89    if(!$irc) {
90        $irc = Net::IRC->new;
91        $irc->timeout(0);
92    }
93}
94
95use constant OPTIONAL_CHANNEL => 1;
96use constant REQUIRE_CHANNEL => 2;
97
98sub register_commands {
99    BarnOwl::new_command('irc-connect' => \&cmd_connect,
100                       {
101                           summary      => 'Connect to an IRC server',
102                           usage        => 'irc-connect [-a ALIAS ] [-s] [-p PASSWORD] [-n NICK] SERVER [port]',
103                           description  =>
104
105                           "Connect to an IRC server. Supported options are\n\n" .
106                           "-a <alias>          Define an alias for this server\n" .
107                           "-s                  Use SSL\n" .
108                           "-p <password>       Specify the password to use\n" .
109                           "-n <nick>           Use a non-default nick"
110                       });
111    BarnOwl::new_command('irc-disconnect' => mk_irc_command(\&cmd_disconnect));
112    BarnOwl::new_command('irc-msg'        => mk_irc_command(\&cmd_msg, OPTIONAL_CHANNEL));
113    BarnOwl::new_command('irc-join'       => mk_irc_command(\&cmd_join));
114    BarnOwl::new_command('irc-part'       => mk_irc_command(\&cmd_part, REQUIRE_CHANNEL));
115    BarnOwl::new_command('irc-nick'       => mk_irc_command(\&cmd_nick));
116    BarnOwl::new_command('irc-names'      => mk_irc_command(\&cmd_names, REQUIRE_CHANNEL));
117    BarnOwl::new_command('irc-whois'      => mk_irc_command(\&cmd_whois));
118    BarnOwl::new_command('irc-motd'       => mk_irc_command(\&cmd_motd));
119    BarnOwl::new_command('irc-list'       => \&cmd_list);
120    BarnOwl::new_command('irc-who'        => mk_irc_command(\&cmd_who));
121    BarnOwl::new_command('irc-stats'      => mk_irc_command(\&cmd_stats));
122    BarnOwl::new_command('irc-topic'      => mk_irc_command(\&cmd_topic, REQUIRE_CHANNEL));
123    BarnOwl::new_command('irc-quote'      => mk_irc_command(\&cmd_quote));
124}
125
126$BarnOwl::Hooks::startup->add('BarnOwl::Module::IRC::startup');
127$BarnOwl::Hooks::shutdown->add('BarnOwl::Module::IRC::shutdown');
128
129################################################################################
130######################## Owl command handlers ##################################
131################################################################################
132
133sub cmd_connect {
134    my $cmd = shift;
135
136    my $nick = BarnOwl::getvar('irc:nick');
137    my $username = BarnOwl::getvar('irc:user');
138    my $ircname = BarnOwl::getvar('irc:name');
139    my $host;
140    my $port;
141    my $alias;
142    my $ssl;
143    my $password = undef;
144
145    {
146        local @ARGV = @_;
147        GetOptions(
148            "alias=s"    => \$alias,
149            "ssl"        => \$ssl,
150            "password=s" => \$password,
151            "nick=s"     => \$nick,
152        );
153        $host = shift @ARGV or die("Usage: $cmd HOST\n");
154        if(!$alias) {
155            if($host =~ /^(?:irc[.])?([\w-]+)[.]\w+$/) {
156                $alias = $1;
157            } else {
158                $alias = $host;
159            }
160        }
161        $ssl ||= 0;
162        $port = shift @ARGV || ($ssl ? 6697 : 6667);
163    }
164
165    if(exists $ircnets{$alias}) {
166        die("Already connected to a server with alias '$alias'. Either disconnect or specify an alias with -a.\n");
167    }
168
169    my $conn = BarnOwl::Module::IRC::Connection->new($irc, $alias,
170        Nick      => $nick,
171        Server    => $host,
172        Port      => $port,
173        Username  => $username,
174        Ircname   => $ircname,
175        Port      => $port,
176        Password  => $password,
177        SSL       => $ssl
178       );
179
180    if ($conn->conn->connected) {
181        BarnOwl::admin_message("IRC", "Connected to $alias as $nick");
182        $ircnets{$alias} = $conn;
183        my $fd = $conn->getSocket()->fileno();
184        BarnOwl::add_dispatch($fd, \&OwlProcess);
185        $conn->{FD} = $fd;
186    } else {
187        die("IRC::Connection->connect failed: $!");
188    }
189
190    return;
191}
192
193sub cmd_disconnect {
194    my $cmd = shift;
195    my $conn = shift;
196    $conn->conn->disconnect;
197    delete $ircnets{$conn->alias};
198}
199
200sub cmd_msg {
201    my $cmd  = shift;
202    my $conn = shift;
203    my $to = shift || shift or die("Usage: $cmd NICK\n");
204    # handle multiple recipients?
205    if(@_) {
206        process_msg($conn, $to, join(" ", @_));
207    } else {
208        BarnOwl::start_edit_win("/msg -a " . $conn->alias . " $to", sub {process_msg($conn, $to, @_)});
209    }
210}
211
212sub process_msg {
213    my $conn = shift;
214    my $to = shift;
215    my $body = shift;
216    # Strip whitespace. In the future -- send one message/line?
217    $body =~ tr/\n\r/  /;
218    if ($body =~ /^\/me (.*)/) {
219        $conn->conn->me($to, $1);
220        $body = '* '.$conn->nick.' '.$1;
221    } else {
222        $conn->conn->privmsg($to, $body);
223    }
224    my $msg = BarnOwl::Message->new(
225        type        => 'IRC',
226        direction   => is_private($to) ? 'out' : 'in',
227        server      => $conn->server,
228        network     => $conn->alias,
229        recipient   => $to,
230        body        => $body,
231        sender      => $conn->nick,
232        is_private($to) ?
233          (isprivate  => 'true') : (channel => $to),
234        replycmd    => "irc-msg -a " . $conn->alias . " $to",
235        replysendercmd => "irc-msg -a " . $conn->alias . " $to"
236       );
237    BarnOwl::queue_message($msg);
238}
239
240sub cmd_join {
241    my $cmd = shift;
242    my $conn = shift;
243    my $chan = shift or die("Usage: $cmd channel\n");
244    $channels{$chan} ||= [];
245    push @{$channels{$chan}}, $conn;
246    $conn->conn->join($chan);
247}
248
249sub cmd_part {
250    my $cmd = shift;
251    my $conn = shift;
252    my $chan = shift;
253    $channels{$chan} = [grep {$_ ne $conn} @{$channels{$chan} || []}];
254    $conn->conn->part($chan);
255}
256
257sub cmd_nick {
258    my $cmd = shift;
259    my $conn = shift;
260    my $nick = shift or die("Usage: $cmd <new nick>\n");
261    $conn->conn->nick($nick);
262}
263
264sub cmd_names {
265    my $cmd = shift;
266    my $conn = shift;
267    my $chan = shift;
268    $conn->names_tmp([]);
269    $conn->conn->names($chan);
270}
271
272sub cmd_whois {
273    my $cmd = shift;
274    my $conn = shift;
275    my $who = shift || die("Usage: $cmd <user>\n");
276    $conn->conn->whois($who);
277}
278
279sub cmd_motd {
280    my $cmd = shift;
281    my $conn = shift;
282    $conn->conn->motd;
283}
284
285sub cmd_list {
286    my $cmd = shift;
287    my $message = BarnOwl::Style::boldify('Current IRC networks:') . "\n";
288    while (my ($alias, $conn) = each %ircnets) {
289        $message .= '  ' . $alias . ' => ' . $conn->nick . '@' . $conn->server . "\n";
290    }
291    BarnOwl::popless_ztext($message);
292}
293
294sub cmd_who {
295    my $cmd = shift;
296    my $conn = shift;
297    my $who = shift || die("Usage: $cmd <user>\n");
298    BarnOwl::error("WHO $cmd $conn $who");
299    $conn->conn->who($who);
300}
301
302sub cmd_stats {
303    my $cmd = shift;
304    my $conn = shift;
305    my $type = shift || die("Usage: $cmd <chiklmouy> [server] \n");
306    $conn->conn->stats($type, @_);
307}
308
309sub cmd_topic {
310    my $cmd = shift;
311    my $conn = shift;
312    my $chan = shift;
313    $conn->conn->topic($chan, @_ ? join(" ", @_) : undef);
314}
315
316sub cmd_quote {
317    my $cmd = shift;
318    my $conn = shift;
319    $conn->conn->sl(join(" ", @_));
320}
321
322################################################################################
323########################### Utilities/Helpers ##################################
324################################################################################
325
326sub mk_irc_command {
327    my $sub = shift;
328    my $use_channel = shift || 0;
329    return sub {
330        my $cmd = shift;
331        my $conn;
332        my $alias;
333        my $channel;
334        my $getopt = Getopt::Long::Parser->new;
335        my $m = BarnOwl::getcurmsg();
336
337        local @ARGV = @_;
338        $getopt->configure(qw(pass_through permute no_getopt_compat prefix_pattern=-|--));
339        $getopt->getoptions("alias=s" => \$alias);
340
341        if(defined($alias)) {
342            $conn = get_connection_by_alias($alias);
343        }
344        if(!$conn && $use_channel) {
345            $channel = $ARGV[-1];
346            if(defined($channel) && $channel =~ /^#/) {
347                if($channels{$channel} && @{$channels{$channel}} == 1) {
348                    pop @ARGV;
349                    $conn = $channels{$channel}[0];
350                } 
351            } else {
352                if($m && $m->type eq 'IRC' && !$m->is_private) {
353                    $channel = $m->channel;
354                } else {
355                    undef $channel;
356                }
357            }
358        }
359        if(!$channel && $use_channel == REQUIRE_CHANNEL) {
360            die("Usage: $cmd <channel>\n");
361        }
362        if(!$conn) {
363            if($m && $m->type eq 'IRC') {
364                $conn = get_connection_by_alias($m->network);
365            }
366        }
367        if(!$conn && scalar keys %ircnets == 1) {
368            $conn = [values(%ircnets)]->[0];
369        }
370        if(!$conn) {
371            die("You must specify an IRC network using -a.\n");
372        }
373        if($use_channel) {
374            $sub->($cmd, $conn, $channel, @ARGV);
375        } else {
376            $sub->($cmd, $conn, @ARGV);
377        }
378    };
379}
380
381sub get_connection_by_alias {
382    my $key = shift;
383    die("No such ircnet: $key\n") unless exists $ircnets{$key};
384    return $ircnets{$key};
385}
386
3871;
Note: See TracBrowser for help on using the repository browser.