[b38b0b2] | 1 | use strict; |
---|
| 2 | use warnings; |
---|
| 3 | |
---|
| 4 | package BarnOwl::Module::IRC::Connection; |
---|
| 5 | |
---|
| 6 | =head1 NAME |
---|
| 7 | |
---|
| 8 | BarnOwl::Module::IRC::Connection |
---|
| 9 | |
---|
| 10 | =head1 DESCRIPTION |
---|
| 11 | |
---|
[ba2ca66] | 12 | This module is a wrapper around Net::IRC::Connection for BarnOwl's IRC |
---|
[b38b0b2] | 13 | support |
---|
| 14 | |
---|
| 15 | =cut |
---|
| 16 | |
---|
[ba2ca66] | 17 | use Net::IRC::Connection; |
---|
| 18 | |
---|
| 19 | use base qw(Class::Accessor Exporter); |
---|
[38cfdb5d] | 20 | __PACKAGE__->mk_accessors(qw(conn alias channels connected motd names_tmp whois_tmp)); |
---|
[2c40dc0] | 21 | our @EXPORT_OK = qw(&is_private); |
---|
[b38b0b2] | 22 | |
---|
| 23 | use BarnOwl; |
---|
| 24 | |
---|
[ba2ca66] | 25 | BEGIN { |
---|
| 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 | |
---|
[b38b0b2] | 35 | sub new { |
---|
| 36 | my $class = shift; |
---|
| 37 | my $irc = shift; |
---|
| 38 | my $alias = shift; |
---|
| 39 | my %args = (@_); |
---|
[ba2ca66] | 40 | my $conn = Net::IRC::Connection->new($irc, %args); |
---|
| 41 | my $self = bless({}, $class); |
---|
| 42 | $self->conn($conn); |
---|
[b38b0b2] | 43 | $self->alias($alias); |
---|
| 44 | $self->channels([]); |
---|
[ba2ca66] | 45 | $self->motd(""); |
---|
| 46 | $self->connected(0); |
---|
[d264c6d] | 47 | $self->names_tmp(0); |
---|
[38cfdb5d] | 48 | $self->whois_tmp(""); |
---|
[ba2ca66] | 49 | |
---|
[5ff830a] | 50 | $self->conn->add_handler(376 => sub { shift; $self->on_connect(@_) }); |
---|
[ba2ca66] | 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', |
---|
[661d2eb] | 55 | 'luserclient', 'luserop', 'luserchannels', 'luserme', |
---|
| 56 | 'error'], |
---|
[ba2ca66] | 57 | sub { shift; $self->on_admin_msg(@_) }); |
---|
| 58 | $self->conn->add_handler(['myinfo', 'map', 'n_local', 'n_global', |
---|
[bc0d7bc] | 59 | 'luserconns'], |
---|
| 60 | sub { }); |
---|
[ba2ca66] | 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(@_) }); |
---|
[4789b17] | 66 | $self->conn->add_handler(quit => sub { shift; $self->on_quit(@_) }); |
---|
[ba2ca66] | 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(@_) }); |
---|
[3ad15ff] | 70 | $self->conn->add_handler(topic => sub { shift; $self->on_topic(@_) }); |
---|
| 71 | $self->conn->add_handler(topicinfo => sub { shift; $self->on_topicinfo(@_) }); |
---|
[38cfdb5d] | 72 | $self->conn->add_handler(namreply => sub { shift; $self->on_namreply(@_) }); |
---|
| 73 | $self->conn->add_handler(endofnames=> sub { shift; $self->on_endofnames(@_) }); |
---|
[d264c6d] | 74 | $self->conn->add_handler(endofwhois=> sub { shift; $self->on_endofwhois(@_) }); |
---|
[b38b0b2] | 75 | |
---|
| 76 | return $self; |
---|
| 77 | } |
---|
| 78 | |
---|
[9c7a701] | 79 | sub getSocket |
---|
| 80 | { |
---|
| 81 | my $self = shift; |
---|
| 82 | return $self->conn->socket; |
---|
| 83 | } |
---|
| 84 | |
---|
[b38b0b2] | 85 | ################################################################################ |
---|
| 86 | ############################### IRC callbacks ################################## |
---|
| 87 | ################################################################################ |
---|
| 88 | |
---|
[47b6a5f] | 89 | sub 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 | |
---|
[b38b0b2] | 103 | sub on_msg { |
---|
| 104 | my ($self, $evt) = @_; |
---|
[2c40dc0] | 105 | my ($recipient) = $evt->to; |
---|
| 106 | my $body = strip_irc_formatting([$evt->args]->[0]); |
---|
[bc0d7bc] | 107 | my $nick = $self->nick; |
---|
| 108 | BarnOwl::beep() if $body =~ /\b\Q$nick\E\b/; |
---|
[2c40dc0] | 109 | $body = BarnOwl::Style::boldify($evt->nick.' '.$body) if $evt->type eq 'caction'; |
---|
[47b6a5f] | 110 | my $msg = $self->new_message($evt, |
---|
[b38b0b2] | 111 | direction => 'in', |
---|
[2c40dc0] | 112 | recipient => $recipient, |
---|
[47b6a5f] | 113 | body => $body, |
---|
[2c40dc0] | 114 | $evt->type eq 'notice' ? |
---|
| 115 | (notice => 'true') : (), |
---|
| 116 | is_private($recipient) ? |
---|
[0e52069] | 117 | (isprivate => 'true') : (channel => $recipient), |
---|
[3c5fe43] | 118 | replycmd => 'irc-msg -a ' . $self->alias . ' ' . |
---|
[2c40dc0] | 119 | (is_private($recipient) ? $evt->nick : $recipient), |
---|
[3c5fe43] | 120 | replysendercmd => 'irc-msg -a ' . $self->alias . ' ' . $evt->nick |
---|
[b38b0b2] | 121 | ); |
---|
[47b6a5f] | 122 | |
---|
[b38b0b2] | 123 | BarnOwl::queue_message($msg); |
---|
| 124 | } |
---|
| 125 | |
---|
[2c40dc0] | 126 | sub on_ping { |
---|
| 127 | my ($self, $evt) = @_; |
---|
[ba2ca66] | 128 | $self->conn->ctcp_reply($evt->nick, join (' ', ($evt->args))); |
---|
[2c40dc0] | 129 | } |
---|
| 130 | |
---|
[bc0d7bc] | 131 | sub on_admin_msg { |
---|
| 132 | my ($self, $evt) = @_; |
---|
| 133 | BarnOwl::admin_message("IRC", |
---|
| 134 | BarnOwl::Style::boldify('IRC ' . $evt->type . ' message from ' |
---|
[1951db8] | 135 | . $self->alias) . "\n" |
---|
[d264c6d] | 136 | . strip_irc_formatting(join ' ', cdr($evt->args))); |
---|
[bc0d7bc] | 137 | } |
---|
| 138 | |
---|
| 139 | sub on_motdstart { |
---|
| 140 | my ($self, $evt) = @_; |
---|
[1af21e8] | 141 | $self->motd(join "\n", cdr($evt->args)); |
---|
[bc0d7bc] | 142 | } |
---|
| 143 | |
---|
| 144 | sub on_motd { |
---|
| 145 | my ($self, $evt) = @_; |
---|
[1af21e8] | 146 | $self->motd(join "\n", $self->motd, cdr($evt->args)); |
---|
[bc0d7bc] | 147 | } |
---|
| 148 | |
---|
| 149 | sub on_endofmotd { |
---|
| 150 | my ($self, $evt) = @_; |
---|
[1af21e8] | 151 | $self->motd(join "\n", $self->motd, cdr($evt->args)); |
---|
[ba2ca66] | 152 | if(!$self->connected) { |
---|
[3baf77f] | 153 | BarnOwl::admin_message("IRC", "Connected to " . |
---|
| 154 | $self->server . " (" . $self->alias . ")"); |
---|
[ba2ca66] | 155 | $self->connected(1); |
---|
[3baf77f] | 156 | |
---|
| 157 | } |
---|
[bc0d7bc] | 158 | BarnOwl::admin_message("IRC", |
---|
[3baf77f] | 159 | BarnOwl::Style::boldify('MOTD for ' . $self->alias) . "\n" |
---|
[ba2ca66] | 160 | . strip_irc_formatting($self->motd)); |
---|
[bc0d7bc] | 161 | } |
---|
| 162 | |
---|
[47b6a5f] | 163 | sub on_join { |
---|
| 164 | my ($self, $evt) = @_; |
---|
| 165 | my $msg = $self->new_message($evt, |
---|
| 166 | loginout => 'login', |
---|
[4789b17] | 167 | action => 'join', |
---|
[47b6a5f] | 168 | channel => $evt->to, |
---|
[d264c6d] | 169 | replycmd => 'irc-msg -a ' . $self->alias . ' ' . join(' ', $evt->to), |
---|
[3c5fe43] | 170 | replysendercmd => 'irc-msg -a ' . $self->alias . ' ' . $evt->nick |
---|
[47b6a5f] | 171 | ); |
---|
| 172 | BarnOwl::queue_message($msg); |
---|
| 173 | } |
---|
| 174 | |
---|
| 175 | sub on_part { |
---|
| 176 | my ($self, $evt) = @_; |
---|
| 177 | my $msg = $self->new_message($evt, |
---|
| 178 | loginout => 'logout', |
---|
[4789b17] | 179 | action => 'part', |
---|
[47b6a5f] | 180 | channel => $evt->to, |
---|
[d264c6d] | 181 | replycmd => 'irc-msg -a ' . $self->alias . ' ' . join(' ', $evt->to), |
---|
[3c5fe43] | 182 | replysendercmd => 'irc-msg -a ' . $self->alias . ' ' . $evt->nick |
---|
[47b6a5f] | 183 | ); |
---|
| 184 | BarnOwl::queue_message($msg); |
---|
| 185 | } |
---|
| 186 | |
---|
[4789b17] | 187 | sub 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 | |
---|
[9e02bb7] | 200 | sub on_disconnect { |
---|
| 201 | my $self = shift; |
---|
| 202 | delete $BarnOwl::Module::IRC::ircnets{$self->alias}; |
---|
[9c7a701] | 203 | BarnOwl::remove_dispatch($self->{FD}); |
---|
[9e02bb7] | 204 | BarnOwl::admin_message('IRC', |
---|
| 205 | "[" . $self->alias . "] Disconnected from server"); |
---|
| 206 | } |
---|
| 207 | |
---|
| 208 | sub on_nickinuse { |
---|
| 209 | my ($self, $evt) = @_; |
---|
| 210 | BarnOwl::admin_message("IRC", |
---|
| 211 | "[" . $self->alias . "] " . |
---|
| 212 | [$evt->args]->[1] . ": Nick already in use"); |
---|
[ba2ca66] | 213 | unless($self->connected) { |
---|
| 214 | $self->conn->disconnect; |
---|
[eab7a4c] | 215 | } |
---|
[9e02bb7] | 216 | } |
---|
| 217 | |
---|
[3ad15ff] | 218 | sub 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 | |
---|
| 230 | sub 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 | |
---|
[38cfdb5d] | 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 | |
---|
| 241 | sub on_namreply { |
---|
| 242 | my ($self, $evt) = @_; |
---|
[d264c6d] | 243 | return unless $self->names_tmp; |
---|
[38cfdb5d] | 244 | $self->names_tmp([@{$self->names_tmp}, split(' ', [$evt->args]->[3])]); |
---|
| 245 | } |
---|
| 246 | |
---|
| 247 | sub on_endofnames { |
---|
| 248 | my ($self, $evt) = @_; |
---|
[d264c6d] | 249 | return unless $self->names_tmp; |
---|
[38cfdb5d] | 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); |
---|
[d264c6d] | 255 | $self->names_tmp(0); |
---|
| 256 | } |
---|
| 257 | |
---|
| 258 | sub 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 | |
---|
| 266 | sub 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 | |
---|
| 275 | sub 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'; |
---|
[38cfdb5d] | 282 | } |
---|
[9e02bb7] | 283 | |
---|
[b38b0b2] | 284 | ################################################################################ |
---|
| 285 | ########################### Utilities/Helpers ################################## |
---|
| 286 | ################################################################################ |
---|
| 287 | |
---|
| 288 | sub strip_irc_formatting { |
---|
| 289 | my $body = shift; |
---|
[214b790] | 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; |
---|
[3835ae8] | 296 | my $out = ''; |
---|
[b38b0b2] | 297 | while(@pieces) { |
---|
| 298 | $out .= shift @pieces; |
---|
| 299 | $out .= BarnOwl::Style::boldify(shift @pieces) if @pieces; |
---|
| 300 | } |
---|
| 301 | return $out; |
---|
| 302 | } |
---|
| 303 | |
---|
[2c40dc0] | 304 | # Determines if the given message recipient is a username, as opposed to |
---|
| 305 | # a channel that starts with # or &. |
---|
| 306 | sub is_private { |
---|
| 307 | return shift !~ /^[\#\&]/; |
---|
| 308 | } |
---|
[b38b0b2] | 309 | |
---|
[bc0d7bc] | 310 | sub cdr { |
---|
| 311 | shift; |
---|
| 312 | return @_; |
---|
| 313 | } |
---|
| 314 | |
---|
[b38b0b2] | 315 | 1; |
---|