source: perl/modules/IRC/lib/BarnOwl/Module/IRC.pm @ 3ad15ff

debianrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 3ad15ff was 3ad15ff, checked in by Geoffrey Thomas <geofft@mit.edu>, 13 years ago
IRC: Add :irc-topic support and on_topic/on_topicinfo callbacks.
  • Property mode set to 100644
File size: 9.7 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
95sub register_commands {
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                       });
108    BarnOwl::new_command('irc-disconnect' => \&cmd_disconnect);
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);
115    BarnOwl::new_command('irc-motd'       => \&cmd_motd);
116    BarnOwl::new_command('irc-list'       => \&cmd_list);
117    BarnOwl::new_command('irc-who'        => \&cmd_who);
118    BarnOwl::new_command('irc-stats'      => \&cmd_stats);
119    BarnOwl::new_command('irc-topic'      => \&cmd_topic);
120}
121
122$BarnOwl::Hooks::startup->add(\&startup);
123$BarnOwl::Hooks::shutdown->add(\&shutdown);
124#$BarnOwl::Hooks::mainLoop->add(\&mainloop_hook);
125
126################################################################################
127######################## Owl command handlers ##################################
128################################################################################
129
130sub cmd_connect {
131    my $cmd = shift;
132
133    my $nick = BarnOwl::getvar('irc:nick');
134    my $username = BarnOwl::getvar('irc:user');
135    my $ircname = BarnOwl::getvar('irc:name');
136    my $host;
137    my $port;
138    my $alias;
139    my $ssl;
140    my $password = undef;
141
142    {
143        local @ARGV = @_;
144        GetOptions(
145            "alias=s"    => \$alias,
146            "ssl"        => \$ssl,
147            "password=s" => \$password,
148            "nick=s"     => \$nick,
149        );
150        $host = shift @ARGV or die("Usage: $cmd HOST\n");
151        if(!$alias) {
152            if($host =~ /^(?:irc[.])?([\w-]+)[.]\w+$/) {
153                $alias = $1;
154            } else {
155                $alias = $host;
156            }
157        }
158        $ssl ||= 0;
159        $port = shift @ARGV || ($ssl ? 6697 : 6667);
160    }
161
162    if(exists $ircnets{$alias}) {
163        die("Already connected to a server with alias '$alias'. Either disconnect or specify an alias with -a.\n");
164    }
165
166    my $conn = BarnOwl::Module::IRC::Connection->new($irc, $alias,
167        Nick      => $nick,
168        Server    => $host,
169        Port      => $port,
170        Username  => $username,
171        Ircname   => $ircname,
172        Port      => $port,
173        Password  => $password,
174        SSL       => $ssl
175       );
176
177    if ($conn->conn->connected) {
178        BarnOwl::admin_message("IRC", "Connected to $alias as $nick");
179        $ircnets{$alias} = $conn;
180        my $fd = $conn->getSocket()->fileno();
181        BarnOwl::add_dispatch($fd, \&OwlProcess);
182        $conn->{FD} = $fd;
183    } else {
184        die("IRC::Connection->connect failed: $!");
185    }
186
187    return;
188}
189
190sub cmd_disconnect {
191    my $cmd = shift;
192    my $conn = get_connection(\@_);
193    $conn->conn->disconnect;
194    delete $ircnets{$conn->alias};
195}
196
197sub cmd_msg {
198    my $cmd = shift;
199    my $conn = get_connection(\@_);
200    my $to = shift or die("Usage: $cmd NICK\n");
201    # handle multiple recipients?
202    if(@_) {
203        process_msg($conn, $to, join(" ", @_));
204    } else {
205        BarnOwl::start_edit_win("/msg -a " . $conn->alias . " $to", sub {process_msg($conn, $to, @_)});
206    }
207}
208
209sub process_msg {
210    my $conn = shift;
211    my $to = shift;
212    my $body = shift;
213    # Strip whitespace. In the future -- send one message/line?
214    $body =~ tr/\n\r/  /;
215    if ($body =~ /^\/me (.*)/) {
216        $conn->conn->me($to, $1);
217        $body = BarnOwl::Style::boldify($conn->nick.' '.$1);
218    } else {
219        $conn->conn->privmsg($to, $body);
220    }
221    my $msg = BarnOwl::Message->new(
222        type        => 'IRC',
223        direction   => is_private($to) ? 'out' : 'in',
224        server      => $conn->server,
225        network     => $conn->alias,
226        recipient   => $to,
227        body        => $body,
228        sender      => $conn->nick,
229        is_private($to) ?
230          (isprivate  => 'true') : (channel => $to),
231        replycmd    => "irc-msg -a " . $conn->alias . " $to",
232        replysendercmd => "irc-msg -a " . $conn->alias . " $to"
233       );
234    BarnOwl::queue_message($msg);
235}
236
237sub cmd_join {
238    my $cmd = shift;
239    my $conn = get_connection(\@_);
240    my $chan = shift or die("Usage: $cmd channel\n");
241    $channels{$chan} ||= [];
242    push @{$channels{$chan}}, $conn;
243    $conn->conn->join($chan);
244}
245
246sub cmd_part {
247    my $cmd = shift;
248    my $conn = get_connection(\@_);
249    my $chan = get_channel(\@_) || die("Usage: $cmd <channel>\n");
250    $channels{$chan} = [grep {$_ ne $conn} @{$channels{$chan} || []}];
251    $conn->conn->part($chan);
252}
253
254sub cmd_nick {
255    my $cmd = shift;
256    my $conn = get_connection(\@_);
257    my $nick = shift or die("Usage: $cmd <new nick>\n");
258    $conn->conn->nick($nick);
259}
260
261sub cmd_names {
262    my $cmd = shift;
263    my $conn = get_connection(\@_);
264    my $chan = get_channel(\@_) || die("Usage: $cmd <channel>\n");
265    $conn->conn->names($chan);
266}
267
268sub cmd_whois {
269    my $cmd = shift;
270    my $conn = get_connection(\@_);
271    my $who = shift || die("Usage: $cmd <user>\n");
272    $conn->conn->whois($who);
273}
274
275sub cmd_motd {
276    my $cmd = shift;
277    my $conn = get_connection(\@_);
278    $conn->conn->motd;
279}
280
281sub cmd_list {
282    my $cmd = shift;
283    my $message = BarnOwl::Style::boldify('Current IRC networks:') . "\n";
284    while (my ($alias, $conn) = each %ircnets) {
285        $message .= '  ' . $alias . ' => ' . $conn->nick . '@' . $conn->server . "\n";
286    }
287    BarnOwl::popless_ztext($message);
288}
289
290sub cmd_who {
291    my $cmd = shift;
292    my $conn = get_connection(\@_);
293    my $who = shift || die("Usage: $cmd <user>\n");
294    $conn->conn->who($who);
295}
296
297sub cmd_stats {
298    my $cmd = shift;
299    my $conn = get_connection(\@_);
300    my $type = shift || die("Usage: $cmd <chiklmouy> [server] \n");
301    $conn->conn->stats($type, @_);
302}
303
304sub cmd_topic {
305    my $cmd = shift;
306    my $conn = get_connection(\@_);
307    $conn->conn->topic(@_);
308}
309
310################################################################################
311########################### Utilities/Helpers ##################################
312################################################################################
313
314sub get_connection {
315    my $args = shift;
316    if(scalar @$args >= 2 && $args->[0] eq '-a') {
317        shift @$args;
318        return get_connection_by_alias(shift @$args);
319    }
320    my $channel = $args->[-1];
321    if (defined($channel) && $channel =~ /^#/
322        and $channels{$channel} and @{$channels{$channel}} == 1) {
323        return $channels{$channel}[0];
324    }
325    my $m = BarnOwl::getcurmsg();
326    if($m && $m->type eq 'IRC') {
327        return get_connection_by_alias($m->network);
328    }
329    if(scalar keys %ircnets == 1) {
330        return [values(%ircnets)]->[0];
331    }
332    die("You must specify a network with -a\n");
333}
334
335sub get_channel {
336    my $args = shift;
337    if(scalar @$args) {
338        return shift @$args;
339    }
340    my $m = BarnOwl::getcurmsg();
341    if($m && $m->type eq 'IRC') {
342        return $m->channel if !$m->is_private;
343    }
344    return undef;
345}
346
347sub get_connection_by_alias {
348    my $key = shift;
349    die("No such ircnet: $key\n") unless exists $ircnets{$key};
350    return $ircnets{$key};
351}
352
3531;
Note: See TracBrowser for help on using the repository browser.