source: perl/modules/IRC/lib/BarnOwl/Module/IRC.pm @ 5ff830a

barnowl_perlaimdebianrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 5ff830a was 5ff830a, checked in by Geoffrey Thomas <geofft@mit.edu>, 13 years ago
* minor changes to IRC * run ./svkversion only once rather than at every cc * fix one-line style to format logouts, not just logins
  • Property mode set to 100644
File size: 8.3 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
71sub mainloop_hook {
72    return unless defined $irc;
73    eval {
74        $irc->do_one_loop();
75    };
76    return;
77}
78
79sub register_handlers {
80    if(!$irc) {
81        $irc = Net::IRC->new;
82        $irc->timeout(0);
83    }
84}
85
86sub register_commands {
[b0c8011]87    BarnOwl::new_command('irc-connect' => \&cmd_connect,
88                       {
89                           summary      => 'Connect to an IRC server',
90                           usage        => 'irc-connect [-a ALIAS ] [-s] [-p PASSWORD] [-n NICK] SERVER [port]',
91                           description  =>
92
93                           "Connect to an IRC server. Supported options are\n\n" .
94                           "-a <alias>          Define an alias for this server\n" .
95                           "-s                  Use SSL\n" .
96                           "-p <password>       Specify the password to use\n" .
97                           "-n <nick>           Use a non-default nick"
98                       });
[b38b0b2]99    BarnOwl::new_command('irc-disconnect' => \&cmd_disconnect);
[b0c8011]100    BarnOwl::new_command('irc-msg'        => \&cmd_msg);
101    BarnOwl::new_command('irc-join'       => \&cmd_join);
102    BarnOwl::new_command('irc-part'       => \&cmd_part);
103    BarnOwl::new_command('irc-nick'       => \&cmd_nick);
104    BarnOwl::new_command('irc-names'      => \&cmd_names);
105    BarnOwl::new_command('irc-whois'      => \&cmd_whois);
[56e72d5]106    BarnOwl::new_command('irc-motd'       => \&cmd_motd);
[b38b0b2]107}
108
109$BarnOwl::Hooks::startup->add(\&startup);
110$BarnOwl::Hooks::shutdown->add(\&shutdown);
111$BarnOwl::Hooks::mainLoop->add(\&mainloop_hook);
112
113################################################################################
114######################## Owl command handlers ##################################
115################################################################################
116
117sub cmd_connect {
118    my $cmd = shift;
119
[2c40dc0]120    my $nick = BarnOwl::getvar('irc:nick');
121    my $username = BarnOwl::getvar('irc:user');
122    my $ircname = BarnOwl::getvar('irc:name');
[b38b0b2]123    my $host;
124    my $port;
125    my $alias;
126    my $ssl;
127    my $password = undef;
128
129    {
130        local @ARGV = @_;
131        GetOptions(
132            "alias=s"    => \$alias,
133            "ssl"        => \$ssl,
[2c40dc0]134            "password=s" => \$password,
[b10f340]135            "nick=s"     => \$nick,
[2c40dc0]136        );
[b38b0b2]137        $host = shift @ARGV or die("Usage: $cmd HOST\n");
138        if(!$alias) {
[b0c8011]139            if($host =~ /^(?:irc[.])?(\w+)[.]\w+$/) {
140                $alias = $1;
141            } else {
142                $alias = $host;
143            }
[b38b0b2]144        }
[b0c8011]145        $port = shift @ARGV || 6667;
[b38b0b2]146        $ssl ||= 0;
147    }
148
[b0c8011]149    if(exists $ircnets{$alias}) {
150        die("Already connected to a server with alias '$alias'. Either disconnect or specify an alias with -a.\n");
151    }
152
[b38b0b2]153    my $conn = BarnOwl::Module::IRC::Connection->new($irc, $alias,
154        Nick      => $nick,
155        Server    => $host,
156        Port      => $port,
157        Username  => $username,
158        Ircname   => $ircname,
159        Port      => $port,
160        Password  => $password,
161        SSL       => $ssl
162       );
163
[5ff830a]164    if ($conn->connected) {
165        BarnOwl::admin_message("IRC", "Connected to $alias as $nick");
166        $ircnets{$alias} = $conn;
167    } else {
168        die("IRC::Connection->connect failed: $!");
169    }
170
[b38b0b2]171    return;
172}
173
174sub cmd_disconnect {
175    my $cmd = shift;
176    my $conn = get_connection(\@_);
[ba2ca66]177    $conn->conn->disconnect;
[b38b0b2]178    delete $ircnets{$conn->alias};
179}
180
181sub cmd_msg {
182    my $cmd = shift;
183    my $conn = get_connection(\@_);
184    my $to = shift or die("Usage: $cmd NICK\n");
[2c40dc0]185    # handle multiple recipients?
[b38b0b2]186    if(@_) {
187        process_msg($conn, $to, join(" ", @_));
188    } else {
189        BarnOwl::start_edit_win("/msg $to -a " . $conn->alias, sub {process_msg($conn, $to, @_)});
190    }
191}
192
193sub process_msg {
194    my $conn = shift;
195    my $to = shift;
196    my $body = shift;
197    # Strip whitespace. In the future -- send one message/line?
198    $body =~ tr/\n\r/  /;
[ba2ca66]199    $conn->conn->privmsg($to, $body);
[b38b0b2]200    my $msg = BarnOwl::Message->new(
201        type        => 'IRC',
[6858d2d]202        direction   => is_private($to) ? 'out' : 'in',
[b38b0b2]203        server      => $conn->server,
204        network     => $conn->alias,
205        recipient   => $to,
206        body        => $body,
207        sender      => $conn->nick,
[2c40dc0]208        is_private($to) ?
[0e52069]209          (isprivate  => 'true') : (channel => $to),
[b38b0b2]210        replycmd    => "irc-msg $to",
[2c40dc0]211        replysendercmd => "irc-msg $to"
[b38b0b2]212       );
213    BarnOwl::queue_message($msg);
214}
215
[2c40dc0]216sub cmd_join {
217    my $cmd = shift;
218    my $conn = get_connection(\@_);
219    my $chan = shift or die("Usage: $cmd channel\n");
[fe8cad8]220    $channels{$chan} ||= [];
221    push @{$channels{$chan}}, $conn;
[ba2ca66]222    $conn->conn->join($chan);
[2c40dc0]223}
[b38b0b2]224
[6858d2d]225sub cmd_part {
226    my $cmd = shift;
227    my $conn = get_connection(\@_);
[b0c8011]228    my $chan = get_channel(\@_) || die("Usage: $cmd <channel>\n");
[fe8cad8]229    $channels{$chan} = [grep {$_ ne $conn} @{$channels{$chan} || []}];
[ba2ca66]230    $conn->conn->part($chan);
[6858d2d]231}
232
[6286f26]233sub cmd_nick {
234    my $cmd = shift;
235    my $conn = get_connection(\@_);
[b0c8011]236    my $nick = shift or die("Usage: $cmd <new nick>\n");
[ba2ca66]237    $conn->conn->nick($nick);
[6286f26]238}
239
[6858d2d]240sub cmd_names {
241    my $cmd = shift;
242    my $conn = get_connection(\@_);
[b0c8011]243    my $chan = get_channel(\@_) || die("Usage: $cmd <channel>\n");
[ba2ca66]244    $conn->conn->names($chan);
[6858d2d]245}
246
[b0c8011]247sub cmd_whois {
248    my $cmd = shift;
249    my $conn = get_connection(\@_);
250    my $who = shift || die("Usage: $cmd <user>\n");
[ba2ca66]251    $conn->conn->whois($who);
[b0c8011]252}
253
[56e72d5]254sub cmd_motd {
255    my $cmd = shift;
256    my $conn = get_connection(\@_);
[ba2ca66]257    $conn->conn->motd;
[56e72d5]258}
259
[b38b0b2]260################################################################################
261########################### Utilities/Helpers ##################################
262################################################################################
263
264sub get_connection {
265    my $args = shift;
266    if(scalar @$args >= 2 && $args->[0] eq '-a') {
267        shift @$args;
268        return get_connection_by_alias(shift @$args);
269    }
[fe8cad8]270    my $channel = $args->[-1];
[56e72d5]271    if (defined($channel) && $channel =~ /^#/
272        and $channels{$channel} and @{$channels{$channel}} == 1) {
[fe8cad8]273        return $channels{$channel}[0];
274    }
[b38b0b2]275    my $m = BarnOwl::getcurmsg();
276    if($m && $m->type eq 'IRC') {
277        return get_connection_by_alias($m->network);
278    }
279    if(scalar keys %ircnets == 1) {
280        return [values(%ircnets)]->[0];
281    }
282    die("You must specify a network with -a\n");
283}
284
[6858d2d]285sub get_channel {
286    my $args = shift;
287    if(scalar @$args) {
288        return shift @$args;
289    }
290    my $m = BarnOwl::getcurmsg();
291    if($m && $m->type eq 'IRC') {
292        return $m->channel if !$m->is_private;
293    }
294    return undef;
295}
296
[b38b0b2]297sub get_connection_by_alias {
[2c40dc0]298    my $key = shift;
299    die("No such ircnet: $key\n") unless exists $ircnets{$key};
[b38b0b2]300    return $ircnets{$key};
301}
302
3031;
Note: See TracBrowser for help on using the repository browser.