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

barnowl_perlaimdebianrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since fe8cad8 was fe8cad8, checked in by Alex Vandiver <alexmv@mit.edu>, 13 years ago
Default connections on a per-channel-name basis
  • Property mode set to 100644
File size: 7.9 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->disconnect();
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 {
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                       });
99    BarnOwl::new_command('irc-disconnect' => \&cmd_disconnect);
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);
106}
107
108$BarnOwl::Hooks::startup->add(\&startup);
109$BarnOwl::Hooks::shutdown->add(\&shutdown);
110$BarnOwl::Hooks::mainLoop->add(\&mainloop_hook);
111
112################################################################################
113######################## Owl command handlers ##################################
114################################################################################
115
116sub cmd_connect {
117    my $cmd = shift;
118
119    my $nick = BarnOwl::getvar('irc:nick');
120    my $username = BarnOwl::getvar('irc:user');
121    my $ircname = BarnOwl::getvar('irc:name');
122    my $host;
123    my $port;
124    my $alias;
125    my $ssl;
126    my $password = undef;
127
128    {
129        local @ARGV = @_;
130        GetOptions(
131            "alias=s"    => \$alias,
132            "ssl"        => \$ssl,
133            "password=s" => \$password,
134            "nick=s"     => \$nick,
135        );
136        $host = shift @ARGV or die("Usage: $cmd HOST\n");
137        if(!$alias) {
138            if($host =~ /^(?:irc[.])?(\w+)[.]\w+$/) {
139                $alias = $1;
140            } else {
141                $alias = $host;
142            }
143        }
144        $port = shift @ARGV || 6667;
145        $ssl ||= 0;
146    }
147
148    if(exists $ircnets{$alias}) {
149        die("Already connected to a server with alias '$alias'. Either disconnect or specify an alias with -a.\n");
150    }
151
152    my $conn = BarnOwl::Module::IRC::Connection->new($irc, $alias,
153        Nick      => $nick,
154        Server    => $host,
155        Port      => $port,
156        Username  => $username,
157        Ircname   => $ircname,
158        Port      => $port,
159        Password  => $password,
160        SSL       => $ssl
161       );
162
163    $ircnets{$alias} = $conn;
164    return;
165}
166
167sub cmd_disconnect {
168    my $cmd = shift;
169    my $conn = get_connection(\@_);
170    $conn->disconnect;
171    delete $ircnets{$conn->alias};
172}
173
174sub cmd_msg {
175    my $cmd = shift;
176    my $conn = get_connection(\@_);
177    my $to = shift or die("Usage: $cmd NICK\n");
178    # handle multiple recipients?
179    if(@_) {
180        process_msg($conn, $to, join(" ", @_));
181    } else {
182        BarnOwl::start_edit_win("/msg $to -a " . $conn->alias, sub {process_msg($conn, $to, @_)});
183    }
184}
185
186sub process_msg {
187    my $conn = shift;
188    my $to = shift;
189    my $body = shift;
190    # Strip whitespace. In the future -- send one message/line?
191    $body =~ tr/\n\r/  /;
192    $conn->privmsg($to, $body);
193    my $msg = BarnOwl::Message->new(
194        type        => 'IRC',
195        direction   => is_private($to) ? 'out' : 'in',
196        server      => $conn->server,
197        network     => $conn->alias,
198        recipient   => $to,
199        body        => $body,
200        sender      => $conn->nick,
201        is_private($to) ?
202          (isprivate  => 'true') : (channel => $to),
203        replycmd    => "irc-msg $to",
204        replysendercmd => "irc-msg $to"
205       );
206    BarnOwl::queue_message($msg);
207}
208
209sub cmd_join {
210    my $cmd = shift;
211    my $conn = get_connection(\@_);
212    my $chan = shift or die("Usage: $cmd channel\n");
213    $channels{$chan} ||= [];
214    push @{$channels{$chan}}, $conn;
215    $conn->join($chan);
216}
217
218sub cmd_part {
219    my $cmd = shift;
220    my $conn = get_connection(\@_);
221    my $chan = get_channel(\@_) || die("Usage: $cmd <channel>\n");
222    $channels{$chan} = [grep {$_ ne $conn} @{$channels{$chan} || []}];
223    $conn->part($chan);
224}
225
226sub cmd_nick {
227    my $cmd = shift;
228    my $conn = get_connection(\@_);
229    my $nick = shift or die("Usage: $cmd <new nick>\n");
230    $conn->nick($nick);
231}
232
233sub cmd_names {
234    my $cmd = shift;
235    my $conn = get_connection(\@_);
236    my $chan = get_channel(\@_) || die("Usage: $cmd <channel>\n");
237    $conn->names($chan);
238}
239
240sub cmd_whois {
241    my $cmd = shift;
242    my $conn = get_connection(\@_);
243    my $who = shift || die("Usage: $cmd <user>\n");
244    $conn->whois($who);
245}
246
247################################################################################
248########################### Utilities/Helpers ##################################
249################################################################################
250
251sub get_connection {
252    my $args = shift;
253    if(scalar @$args >= 2 && $args->[0] eq '-a') {
254        shift @$args;
255        return get_connection_by_alias(shift @$args);
256    }
257    my $channel = $args->[-1];
258    if ($channel =~ /^#/ and $channels{$channel} and @{$channels{$channel}} == 1) {
259        return $channels{$channel}[0];
260    }
261    my $m = BarnOwl::getcurmsg();
262    if($m && $m->type eq 'IRC') {
263        return get_connection_by_alias($m->network);
264    }
265    if(scalar keys %ircnets == 1) {
266        return [values(%ircnets)]->[0];
267    }
268    die("You must specify a network with -a\n");
269}
270
271sub get_channel {
272    my $args = shift;
273    if(scalar @$args) {
274        return shift @$args;
275    }
276    my $m = BarnOwl::getcurmsg();
277    if($m && $m->type eq 'IRC') {
278        return $m->channel if !$m->is_private;
279    }
280    return undef;
281}
282
283sub get_connection_by_alias {
284    my $key = shift;
285    die("No such ircnet: $key\n") unless exists $ircnets{$key};
286    return $ircnets{$key};
287}
288
2891;
Note: See TracBrowser for help on using the repository browser.