source: perl/modules/IRC/lib/BarnOwl/Module/IRC/Connection.pm @ 3048f1f

debianrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 3048f1f was 3048f1f, checked in by Anders Kaseorg <andersk@mit.edu>, 13 years ago
Show incoming IRC /me messages with * instead of bold, too.
  • Property mode set to 100644
File size: 9.5 KB
Line 
1use strict;
2use warnings;
3
4package BarnOwl::Module::IRC::Connection;
5
6=head1 NAME
7
8BarnOwl::Module::IRC::Connection
9
10=head1 DESCRIPTION
11
12This module is a wrapper around Net::IRC::Connection for BarnOwl's IRC
13support
14
15=cut
16
17use Net::IRC::Connection;
18
19use base qw(Class::Accessor Exporter);
20__PACKAGE__->mk_accessors(qw(conn alias channels connected motd names_tmp whois_tmp));
21our @EXPORT_OK = qw(&is_private);
22
23use BarnOwl;
24
25BEGIN {
26    no strict 'refs';
27    my @delegate = qw(nick server);
28    for my $meth (@delegate) {
29        *{"BarnOwl::Module::IRC::Connection::$meth"} = sub {
30            shift->conn->$meth(@_);
31        }
32    }
33};
34
35sub new {
36    my $class = shift;
37    my $irc = shift;
38    my $alias = shift;
39    my %args = (@_);
40    my $conn = Net::IRC::Connection->new($irc, %args);
41    my $self = bless({}, $class);
42    $self->conn($conn);
43    $self->alias($alias);
44    $self->channels([]);
45    $self->motd("");
46    $self->connected(0);
47    $self->names_tmp(0);
48    $self->whois_tmp("");
49
50    $self->conn->add_handler(376 => sub { shift; $self->on_connect(@_) });
51    $self->conn->add_default_handler(sub { shift; $self->on_event(@_) });
52    $self->conn->add_handler(['msg', 'notice', 'public', 'caction'],
53            sub { shift; $self->on_msg(@_) });
54    $self->conn->add_handler(['welcome', 'yourhost', 'created',
55                              'luserclient', 'luserop', 'luserchannels', 'luserme',
56                              'error'],
57            sub { shift; $self->on_admin_msg(@_) });
58    $self->conn->add_handler(['myinfo', 'map', 'n_local', 'n_global',
59            'luserconns'],
60            sub { });
61    $self->conn->add_handler(motdstart => sub { shift; $self->on_motdstart(@_) });
62    $self->conn->add_handler(motd      => sub { shift; $self->on_motd(@_) });
63    $self->conn->add_handler(endofmotd => sub { shift; $self->on_endofmotd(@_) });
64    $self->conn->add_handler(join      => sub { shift; $self->on_join(@_) });
65    $self->conn->add_handler(part      => sub { shift; $self->on_part(@_) });
66    $self->conn->add_handler(quit      => sub { shift; $self->on_quit(@_) });
67    $self->conn->add_handler(disconnect => sub { shift; $self->on_disconnect(@_) });
68    $self->conn->add_handler(nicknameinuse => sub { shift; $self->on_nickinuse(@_) });
69    $self->conn->add_handler(cping     => sub { shift; $self->on_ping(@_) });
70    $self->conn->add_handler(topic     => sub { shift; $self->on_topic(@_) });
71    $self->conn->add_handler(topicinfo => sub { shift; $self->on_topicinfo(@_) });
72    $self->conn->add_handler(namreply  => sub { shift; $self->on_namreply(@_) });
73    $self->conn->add_handler(endofnames=> sub { shift; $self->on_endofnames(@_) });
74    $self->conn->add_handler(endofwhois=> sub { shift; $self->on_endofwhois(@_) });
75
76    return $self;
77}
78
79sub getSocket
80{
81    my $self = shift;
82    return $self->conn->socket;
83}
84
85################################################################################
86############################### IRC callbacks ##################################
87################################################################################
88
89sub new_message {
90    my $self = shift;
91    my $evt = shift;
92    return BarnOwl::Message->new(
93        type        => 'IRC',
94        server      => $self->server,
95        network     => $self->alias,
96        sender      => $evt->nick,
97        hostname    => $evt->host,
98        from        => $evt->from,
99        @_
100       );
101}
102
103sub on_msg {
104    my ($self, $evt) = @_;
105    my ($recipient) = $evt->to;
106    my $body = strip_irc_formatting([$evt->args]->[0]);
107    my $nick = $self->nick;
108    BarnOwl::beep() if $body =~ /\b\Q$nick\E\b/;
109    $body = '* '.$evt->nick.' '.$body if $evt->type eq 'caction';
110    my $msg = $self->new_message($evt,
111        direction   => 'in',
112        recipient   => $recipient,
113        body => $body,
114        $evt->type eq 'notice' ?
115          (notice     => 'true') : (),
116        is_private($recipient) ?
117          (isprivate  => 'true') : (channel => $recipient),
118        replycmd    => 'irc-msg -a ' . $self->alias . ' ' .
119            (is_private($recipient) ? $evt->nick : $recipient),
120        replysendercmd => 'irc-msg -a ' . $self->alias . ' ' . $evt->nick
121       );
122
123    BarnOwl::queue_message($msg);
124}
125
126sub on_ping {
127    my ($self, $evt) = @_;
128    $self->conn->ctcp_reply($evt->nick, join (' ', ($evt->args)));
129}
130
131sub on_admin_msg {
132    my ($self, $evt) = @_;
133    BarnOwl::admin_message("IRC",
134            BarnOwl::Style::boldify('IRC ' . $evt->type . ' message from '
135                . $self->alias) . "\n"
136            . strip_irc_formatting(join ' ', cdr($evt->args)));
137}
138
139sub on_motdstart {
140    my ($self, $evt) = @_;
141    $self->motd(join "\n", cdr($evt->args));
142}
143
144sub on_motd {
145    my ($self, $evt) = @_;
146    $self->motd(join "\n", $self->motd, cdr($evt->args));
147}
148
149sub on_endofmotd {
150    my ($self, $evt) = @_;
151    $self->motd(join "\n", $self->motd, cdr($evt->args));
152    if(!$self->connected) {
153        BarnOwl::admin_message("IRC", "Connected to " .
154                               $self->server . " (" . $self->alias . ")");
155        $self->connected(1);
156       
157    }
158    BarnOwl::admin_message("IRC",
159            BarnOwl::Style::boldify('MOTD for ' . $self->alias) . "\n"
160            . strip_irc_formatting($self->motd));
161}
162
163sub on_join {
164    my ($self, $evt) = @_;
165    my $msg = $self->new_message($evt,
166        loginout   => 'login',
167        action     => 'join',
168        channel    => $evt->to,
169        replycmd => 'irc-msg -a ' . $self->alias . ' ' . join(' ', $evt->to),
170        replysendercmd => 'irc-msg -a ' . $self->alias . ' ' . $evt->nick
171        );
172    BarnOwl::queue_message($msg);
173}
174
175sub on_part {
176    my ($self, $evt) = @_;
177    my $msg = $self->new_message($evt,
178        loginout   => 'logout',
179        action     => 'part',
180        channel    => $evt->to,
181        replycmd => 'irc-msg -a ' . $self->alias . ' ' . join(' ', $evt->to),
182        replysendercmd => 'irc-msg -a ' . $self->alias . ' ' . $evt->nick
183        );
184    BarnOwl::queue_message($msg);
185}
186
187sub on_quit {
188    my ($self, $evt) = @_;
189    my $msg = $self->new_message($evt,
190        loginout   => 'logout',
191        action     => 'quit',
192        from       => $evt->to,
193        reason     => [$evt->args]->[0],
194        replycmd => 'irc-msg -a ' . $self->alias . ' ' . $evt->nick,
195        replysendercmd => 'irc-msg -a ' . $self->alias . ' ' . $evt->nick
196        );
197    BarnOwl::queue_message($msg);
198}
199
200sub on_disconnect {
201    my $self = shift;
202    delete $BarnOwl::Module::IRC::ircnets{$self->alias};
203    BarnOwl::remove_dispatch($self->{FD});
204    BarnOwl::admin_message('IRC',
205                           "[" . $self->alias . "] Disconnected from server");
206}
207
208sub on_nickinuse {
209    my ($self, $evt) = @_;
210    BarnOwl::admin_message("IRC",
211                           "[" . $self->alias . "] " .
212                           [$evt->args]->[1] . ": Nick already in use");
213    unless($self->connected) {
214        $self->conn->disconnect;
215    }
216}
217
218sub on_topic {
219    my ($self, $evt) = @_;
220    my @args = $evt->args;
221    if (scalar @args > 1) {
222        BarnOwl::admin_message("IRC",
223                "Topic for $args[1] on " . $self->alias . " is $args[2]");
224    } else {
225        BarnOwl::admin_message("IRC",
226                "Topic changed to $args[0]");
227    }
228}
229
230sub on_topicinfo {
231    my ($self, $evt) = @_;
232    my @args = $evt->args;
233    BarnOwl::admin_message("IRC",
234        "Topic for $args[1] set by $args[2] at " . localtime($args[3]));
235}
236
237# IRC gives us a bunch of namreply messages, followed by an endofnames.
238# We need to collect them from the namreply and wait for the endofnames message.
239# After this happens, the names_tmp variable is cleared.
240
241sub on_namreply {
242    my ($self, $evt) = @_;
243    return unless $self->names_tmp;
244    $self->names_tmp([@{$self->names_tmp}, split(' ', [$evt->args]->[3])]);
245}
246
247sub on_endofnames {
248    my ($self, $evt) = @_;
249    return unless $self->names_tmp;
250    my $names = BarnOwl::Style::boldify("Members of " . [$evt->args]->[1] . ":\n");
251    for my $name (@{$self->names_tmp}) {
252        $names .= "  $name\n";
253    }
254    BarnOwl::popless_ztext($names);
255    $self->names_tmp(0);
256}
257
258sub on_whois {
259    my ($self, $evt) = @_;
260    $self->whois_tmp(
261      $self->whois_tmp . "\n" . $evt->type . ":\n  " .
262      join("\n  ", cdr(cdr($evt->args))) . "\n"
263    );
264}
265
266sub on_endofwhois {
267    my ($self, $evt) = @_;
268    BarnOwl::popless_ztext(
269        BarnOwl::Style::boldify("/whois for " . [$evt->args]->[1] . ":\n") .
270        $self->whois_tmp
271    );
272    $self->whois_tmp([]);
273}
274
275sub on_event {
276    my ($self, $evt) = @_;
277    return on_whois(@_) if ($evt->type =~ /^whois/);
278    BarnOwl::admin_message("IRC",
279            "[" . $self->alias . "] Unhandled IRC event of type " . $evt->type . ":\n"
280            . strip_irc_formatting(join("\n", $evt->args)))
281        if BarnOwl::getvar('irc:spew') eq 'on';
282}
283
284################################################################################
285########################### Utilities/Helpers ##################################
286################################################################################
287
288sub strip_irc_formatting {
289    my $body = shift;
290    # Strip mIRC colors. If someone wants to write code to convert
291    # these to zephyr colors, be my guest.
292    $body =~ s/\cC\d+(?:,\d+)?//g;
293    $body =~ s/\cO//g;
294   
295    my @pieces = split /\cB/, $body;
296    my $out = '';
297    while(@pieces) {
298        $out .= shift @pieces;
299        $out .= BarnOwl::Style::boldify(shift @pieces) if @pieces;
300    }
301    return $out;
302}
303
304# Determines if the given message recipient is a username, as opposed to
305# a channel that starts with # or &.
306sub is_private {
307    return shift !~ /^[\#\&]/;
308}
309
310sub cdr {
311    shift;
312    return @_;
313}
314
3151;
Note: See TracBrowser for help on using the repository browser.