/
stalker.pl
448 lines (367 loc) · 14.6 KB
/
stalker.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
use Irssi;
use vars qw/$VERSION %IRSSI/;
use File::Spec;
use DBI;
use POSIX qw/ strftime /;
# Requires:
# DBI
# DBD::SQLite
$VERSION = '0.74';
%IRSSI = (
authors => 'SymKat',
contact => 'symkat@symkat.com',
name => "stalker",
decsription => 'Records and correlates nick!user@host information',
license => "BSD",
url => "http://github.com/symkat/stalker",
changed => "2011-09-15",
changes => "See Change Log",
);
# Bindings
Irssi::signal_add_last( 'event 311', \&whois_request );
Irssi::signal_add( 'message join', \&nick_joined );
Irssi::signal_add( 'nicklist changed', \&nick_changed_channel );
Irssi::signal_add( 'channel sync', \&channel_sync );
Irssi::signal_add( 'pidwait', \&record_added );
Irssi::command_bind( 'host_lookup', \&host_request );
Irssi::command_bind( 'nick_lookup', \&nick_request );
Irssi::theme_register([
$IRSSI{'name'} => '{whois stalker %|$1}',
$IRSSI{'name'} . '_join' => '{channick_hilight $0} {chanhost_hilight $1} has joined '
. '{hilight $2} ({channel $3})',
]);
# Settings
Irssi::settings_add_str( 'Stalker', $IRSSI{name} . "_db_path", "nicks.db" );
Irssi::settings_add_str( 'Stalker', $IRSSI{name} . "_max_recursion", 20 );
Irssi::settings_add_str( 'Stalker', $IRSSI{name} . "_guest_nick_regex", "^guest" );
Irssi::settings_add_str( 'Stalker', $IRSSI{name} . "_guest_host_regex", "^webchat" );
Irssi::settings_add_str( 'Stalker', $IRSSI{name} . "_debug_log_file", "stalker.log" );
Irssi::settings_add_bool( 'Stalker', $IRSSI{name} . "_verbose", 0 );
Irssi::settings_add_bool( 'Stalker', $IRSSI{name} . "_debug", 0 );
Irssi::settings_add_bool( 'Stalker', $IRSSI{name} . "_recursive_search", 1 );
Irssi::settings_add_bool( 'Stalker', $IRSSI{name} . "_search_this_network_only", 0 );
Irssi::settings_add_bool( 'Stalker', $IRSSI{name} . "_ignore_guest_nicks", 1 );
Irssi::settings_add_bool( 'Stalker', $IRSSI{name} . "_ignore_guest_hosts", 0 );
Irssi::settings_add_bool( 'Stalker', $IRSSI{name} . "_debug_log", 0 );
Irssi::settings_add_bool( 'Stalker', $IRSSI{name} . "_stalk_on_join", 0 );
Irssi::settings_add_bool( 'Stalker', $IRSSI{name} . "_normalize_nicks", 1 );
my $count;
my %data;
my $str;
# Database
my $db = Irssi::settings_get_str($IRSSI{name} . '_db_path');
if ( ! File::Spec->file_name_is_absolute($db) ) {
$db = File::Spec->catfile( Irssi::get_irssi_dir(), $db );
}
stat_database( $db );
my $DBH = DBI->connect(
'dbi:SQLite:dbname='.$db, "", "",
{
RaiseError => 1,
AutoCommit => 1,
}
) or die "Failed to connect to database $db: " . $DBI::errstr;
# DBI::SQLite and fork() don't mix. Do it anyhow but keep the parent and child DBH separate?
# Ideally the child should open its own connection.
my $DBH_child = DBI->connect(
'dbi:SQLite:dbname='.$db, "", "",
{
RaiseError => 1,
AutoCommit => 1,
}
) or die "Failed to connect to database $db: " . $DBI::errstr;
# async data
my @records_to_add; # Queue of records to add
my $child_running = 0; # child pid that is running
# IRSSI Routines
sub whois_request {
my ( $server, $data, $server_name ) = @_;
my ( $me, $n, $u, $h ) = split(" ", $data );
$server->printformat($n,MSGLEVEL_CRAP,$IRSSI{'name'},$n,
join( ", ", (get_records('host', $h, $server->{address}))) . "." );
}
sub host_request {
windowPrint( join( ", ", (get_records('host', $_[0], $_[1]->{address}))) . ".");
}
sub nick_request {
windowPrint( join( ", ", (get_records('nick', $_[0], $_[1]->{address}))) . ".");
}
# Record Adding Functions
sub nick_joined {
my ( $server, $channel, $nick, $address ) = @_;
my ( $user, $host ) = ( split ( '@', $address, 2 ) );
add_record( $nick, $user, $host, $server->{address});
if ( Irssi::settings_get_bool($IRSSI{name} . "_stalk_on_join") ) {
my $window = $server->channel_find($channel);
my @used_nicknames = get_records( 'host', $host, $server->{address} );
$window->printformat( MSGLEVEL_JOINS, 'stalker_join',
$nick, $address, $channel, join( ", ", @used_nicknames ));
Irssi::signal_stop();
}
}
sub nick_changed_channel {
add_record( $_[1]->{nick}, (split( '@', $_[1]->{host} )), $_[0]->{server}->{address} );
}
sub channel_sync {
my ( $channel ) = @_;
my $serv = $channel->{server}->{address};
for my $nick ( $channel->nicks() ) {
last if $nick->{host} eq ''; # Sometimes channel sync doesn't give us this...
add_record( $nick->{nick}, ( split( '@', $nick->{host} ) ), $serv );
}
}
# Automatic Database Creation And Checking
sub stat_database {
my ( $db_file ) = @_;
my $do = 0;
debugPrint("info", "Stat database.");
if ( ! -e $db_file ) {
open my $fh, '>', $db_file
or die "Cannot create database file. Abort.";
close $fh;
$do = 1;
}
my $DBH = DBI->connect(
'dbi:SQLite:dbname='.$db_file, "", "",
{
RaiseError => 1,
AutoCommit => 1,
}
);
create_database( $DBH ) if $do;
my $sth = $DBH->prepare( "SELECT nick from records WHERE serv = ?" );
$sth->execute( 'script-test-string' );
my $sane = $sth->fetchrow_array;
create_database( $DBH ) if $sane == undef;
# Magical testing for the new "added" column; this column was added later
# Need to test for its existance and "add" it if missing
$sth = $DBH->prepare( "SELECT * FROM records WHERE serv = ?;" );
$sth->execute( 'script-test-string' );
my @arr = $sth->fetchrow_array; # I can't convert to a row count without storing in an array first
if( scalar(@arr) == 4 ) { # 4 columns is the old format
debugPrint("info", "Add timestamp column to existing database.");
add_timestamp_column($DBH);
}
elsif( scalar(@arr) != 5 ) { # 5 is the new. Anything else is ... wrong
die "The DB should have 4 or 5 columns. Found " . scalar(@arr);
}
}
# Create a new table with the extra column, move the data over. delete old table and alter name
sub add_timestamp_column {
my ( $DBH ) = @_;
my @queries = ( "CREATE TABLE new_records (nick TEXT NOT NULL," .
"user TEXT NOT NULL, host TEXT NOT NULL, serv TEXT NOT NULL, " .
"added DATE NOT NULL DEFAULT CURRENT_TIMESTAMP)",
"INSERT INTO new_records (nick,user,host,serv) SELECT nick,user,host,serv FROM records;",
"DROP TABLE records;",
"ALTER TABLE new_records RENAME TO records;"
);
for my $query (@queries) {
my $sth = $DBH->prepare($query) or die "Failed to prepare '$query'. " . $sth->err;
$sth->execute() or die "Failed to execute '$query'. " . $sth->err;
}
}
sub create_database {
my ( $DBH ) = @_;
my $query = "CREATE TABLE records (nick TEXT NOT NULL," .
"user TEXT NOT NULL, host TEXT NOT NULL, serv TEXT NOT NULL, " .
"added DATE NOT NULL DEFAULT CURRENT_TIMESTAMP)";
$DBH->do( "DROP TABLE IF EXISTS records" );
$DBH->do( $query );
my $sth = $DBH->prepare( "INSERT INTO records (nick, user, host, serv) VALUES( ?, ?, ?, ? )" );
$sth->execute( 1, 1, 1, 'script-test-string' );
}
# Other Routines
# Strip certain chars from the nick if the nick exists without them
sub normalize {
my ( @nicks ) = @_;
my ( %nicks, %ret ) = map { $_, 1 } @nicks;
for my $nick ( @nicks ) {
(my $base = $nick ) =~ s/[\Q-_~^`\E]//g;
$ret{ exists $nicks{$base} ? $base : $nick }++;
}
return keys %ret;
}
sub add_record {
my ( $nick, $user, $host, $serv ) = @_;
return unless ($nick and $user and $host and $serv);
# Queue the record data and run child unless it's already forked
debugPrint("info", "Queue record to add to DB and, if needed, start child process.");
push @records_to_add, [$nick, $user, $host, $serv];
async_add() if (not $child_running);
}
# Signalled by pidwait -> child exited -> set child not running and fork() again if items are queued
sub record_added
{
$child_running = 0;
debugPrint("info", "Child process complete. Make new child if needed.");
async_add() if (@records_to_add);
}
# Grab the queue and fork a child to process it
# Signal parent when child is done so we know when it's safe to fork() again
sub async_add
{
return unless (@records_to_add);
# Copy the queue of records
my @record_list = @records_to_add;
my $pid = fork();
if (not defined $pid)
{
debugPrint( "crit", "Failed to fork()" );
return;
}
# The child is working.
# Parent uses this to prevent fork()ing until child finishes.
# Child uses this to prevent doing things that only the parent should do.
$child_running = $pid;
if ($pid > 0) # parent thread
{
@records_to_add = (); # Reset the queue
Irssi::pidwait_add($pid); # Signal when child is done
return;
}
# First thing is to unregister signals. That might prevent the child from catching whatever is causing Issue #3
Irssi::signal_remove( 'event 311', \&whois_request );
Irssi::signal_remove( 'message join', \&nick_joined );
Irssi::signal_remove( 'nicklist changed', \&nick_changed_channel );
Irssi::signal_remove( 'channel sync', \&channel_sync );
Irssi::signal_remove( 'pidwait', \&record_added );
Irssi::command_unbind( 'host_lookup', \&host_request );
Irssi::command_unbind( 'nick_lookup', \&nick_request );
# In child, do the database tasks
db_add_record(@{$_}) for (@record_list);
# When done, exit which signals the parent
POSIX::_exit(1);
}
sub db_add_record
{
my ($nick, $user, $host, $serv) = @_;
# Check if we already have this record.
my $q = "SELECT nick FROM records WHERE nick = ? AND user = ? AND host = ? AND serv = ?";
my $sth = $DBH_child->prepare( $q );
$sth->execute( $nick, $user, $host, $serv );
my $result = $sth->fetchrow_hashref;
if ( $result->{nick} eq $nick ) {
#debugPrint( "info", "Record for $nick skipped - already exists." );
return 1;
}
debugPrint( "info", "Adding to DB: nick = $nick, user = $user, host = $host, serv = $serv" );
# We don't have the record, add it.
$sth = $DBH_child->prepare
("INSERT INTO records (nick,user,host,serv) VALUES( ?, ?, ?, ? )" );
eval { $sth->execute( $nick, $user, $host, $serv ) };
if ($@) {
debugPrint( "crit", "Failed to process record, database said: $@" );
}
debugPrint( "info", "Added record for $nick!$user\@$host to $serv" );
}
sub get_records {
my ( $type, $query, $serv, @return ) = @_;
$count = 0; %data = ( );
my %data = _r_search( $serv, $type, $query );
for my $k ( keys %data ) {
debugPrint( "info", "$type query for records on $query from server $serv returned: $k" );
push @return, $k if $data{$k} eq 'nick';
}
if ( Irssi::settings_get_bool($IRSSI{name} . "_normalize_nicks" ) ) {
@return = normalize(@return);
}
# case-insensitive sort
return sort {uc($a) cmp uc($b)} @return;
}
sub _r_search {
my ( $serv, $type, @input ) = @_;
return %data if $count > 1000;
return %data if $count > Irssi::settings_get_str($IRSSI{name} . "_max_recursion");
return %data if $count == 2 and ! Irssi::settings_get_bool( $IRSSI{name} . "_recursive_search" );
debugPrint( "info", "Recursion Level: $count" );
if ( $type eq 'nick' ) {
$count++;
for my $nick ( @input ) {
next if exists $data{$nick};
$data{$nick} = 'nick';
my @hosts = _get_hosts_from_nick( $nick, $serv );
_r_search( $serv, 'host', @hosts );
}
} elsif ( $type eq 'host' ) {
$count++;
for my $host ( @input ) {
next if exists $data{$host};
$data{$host} = 'host';
my @nicks = _get_nicks_from_host( $host, $serv );
verbosePrint( "Got nicks: " . join( ", ", @nicks ) . " from host $host" );
_r_search( $serv, 'nick', @nicks );
}
}
return %data;
}
sub _get_hosts_from_nick {
my ( $nick, $serv, @return ) = @_;
my $sth;
if ( Irssi::settings_get_bool( $IRSSI{name} . "_search_this_network_only" ) ){
$sth = $DBH->prepare( "SELECT nick, host FROM records WHERE nick = ? AND serv = ?" );
$sth->execute( $nick, $serv );
} else {
$sth = $DBH->prepare( "SELECT nick, host FROM records WHERE nick = ?" );
$sth->execute( $nick );
}
return _ignore_guests( 'host', $sth );
}
sub _get_nicks_from_host {
my ( $host, $serv, @return ) = @_;
my $sth;
if ( Irssi::settings_get_bool( $IRSSI{name} . "_search_this_network_only" ) ){
$sth = $DBH->prepare( "SELECT nick, host FROM records WHERE host = ? AND serv = ?" );
$sth->execute( $host, $serv );
} else {
$sth = $DBH->prepare( "SELECT nick, host FROM records WHERE host = ?" );
$sth->execute( $host );
}
return _ignore_guests( 'nick', $sth );
}
sub _ignore_guests {
my ( $field, $sth ) = @_;
my @return;
while ( my $row = $sth->fetchrow_hashref ) {
if ( Irssi::settings_get_bool($IRSSI{name} . "_ignore_guest_nicks") ) {
my $regex = Irssi::settings_get_str( $IRSSI{name} . "_guest_nick_regex" );
next if( $row->{nick} =~ m/$regex/i );
}
if ( Irssi::settings_get_bool($IRSSI{name} . "_ignore_guest_hosts") ) {
my $regex = Irssi::settings_get_str( $IRSSI{name} . "_guest_host_regex" );
next if( $row->{host} =~ m/$regex/i );
}
push @return, $row->{$field};
}
return @return;
}
# Handle printing.
sub debugPrint {
# Short cut - instead of two debug statements thoughout the code,
# we'll send all debugPrint's to the debugLog function as well
windowPrint( $IRSSI{name} . " Debug: " . $_[1] )
if Irssi::settings_get_bool($IRSSI{name} . "_debug");
debugLog( $_[0], $_[1] );
}
sub verbosePrint {
windowPrint( $IRSSI{name} . " Verbose: " . $_[0] )
if Irssi::settings_get_bool($IRSSI{name} . "_verbose");
}
sub debugLog {
my ( $lvl, $msg ) = @_;
return unless Irssi::settings_get_bool($IRSSI{name} . "_debug_log" );
my $now = strftime( "[%D %H:%M:%S]", localtime );
my $logpath = Irssi::settings_get_str( $IRSSI{name} . "_debug_log_file" );
if ( ! File::Spec->file_name_is_absolute($logpath) ) {
$logpath = File::Spec->catfile( Irssi::get_irssi_dir(), $logpath );
}
open my $fh, ">>", $logpath
or die "Fatal error: Cannot open my logfile at " . $IRSSI{name} . "_debug_log_file for writing: $!";
print $fh "[$lvl] $now $msg\n";
close $fh;
}
sub windowPrint {
Irssi::active_win()->print( $_[0] );
}
windowPrint( "Loaded $IRSSI{'name'}" );
# Happy apt-get'ing, azizLIGHTS