SoftSnow_filter.pl

   1 #!/usr/bin/perl
   2
   3 use strict;
   4 use warnings;
   5
   6 use File::Temp qw(tempfile);
   7 use File::Copy qw(move);
   8
   9
  10 my $scriptName    = "SoftSnow XChat2 Filter";
  11 my $scriptVersion = "2.1.0";
  12 my $scriptDescr   = "Filter out file server announcements and IRC SPAM";
  13
  14 my $B = chr 2;  # bold
  15 my $U = chr 31; # underline
  16 my $C = chr 3;  # start of color sequence
  17
  18 ### config ###
  19 my $filter_file = Xchat::get_info("xchatdir") . "/SoftSnow_filter.conf";
  20
  21 my $filter_turned_on = 0;  # is filter is turned on
  22 my $limit_to_server  = ''; # if true limit to given server (host)
  23 my $use_filter_allow = 0;  # use overrides (ALLOW before DENY)
  24
  25 my $filtered_to_window = 0;
  26 my $filter_window = "(filtered)";
  27 ### end config ###
  28
  29 my $filter_commands = 'ON|OFF|STATUS|SERVER|SERVERON|ALL|HELP|DEBUG|PRINT|ALLOW|ADD|DELETE|SAVE|LOAD';
  30
  31 my $filter_help = <<"EOF";
  32 ${B}/FILTER $filter_commands${B}
  33 /FILTER ON|OFF - turns filtering on/off
  34 /FILTER HELP - prints this help message
  35 /FILTER STATUS - prints if filter is turned on, and with what limits
  36 /FILTER DEBUG - shows some info; used in debuggin the filter
  37 /FILTER PRINT - prints all the rules
  38 /FILTER ALLOW - toggle use of ALLOW rules (before DENY).
  39 /FILTER SERVER - limits filtering to current server (host)
  40 /FILTER SERVERON - limits to server and turns filter on
  41 /FILTER ALL - resumes filtering everywhere i.e. removes limits
  42 /FILTER SAVE - saves the rules to the file $filter_file
  43 /FILTER LOAD - loads the rules from the file, replacing existing rules
  44 /FILTER ADD <rule> - add rule at the end of the DENY rules
  45 /FILTER DELETE [<num>] - delete rule number <num>, or last rule
  46 /FILTER SHOW   [<num>] - show rule number <num>, or last rule
  47 /FILTER VERSION - prints the name and version of this script
  48 /FILTER without parameter is equivalent to /FILTER STATUS
  49 EOF
  50
  51 my $filterwindow_commands = 'ON|OFF';
  52
  53 my $filterwindow_help = <<"EOF";
  54 ${B}/FILTERWINDOW $filterwindow_commands${B}
  55 /FILTERWINDOW ON|OFF - turns saving filtered content to ${U}$filter_window${U}
  56 EOF
  57
  58 Xchat::register($scriptName, $scriptVersion, $scriptDescr);
  59
  60 Xchat::hook_command("FILTER", \&filter_command_handler,
  61                     { help_text => $filter_help });
  62 Xchat::hook_command("FILTERWINDOW", \&filterwindow_command_handler,
  63                     { help_text => $filterwindow_help });
  64 Xchat::hook_server("PRIVMSG", \&privmsg_handler);
  65
  66 Xchat::print("Loading ${B}$scriptName $scriptVersion${B}\n".
  67              " For help: ${B}/FILTER HELP${B}\n");
  68
  69 # GUI, windows, etc.
  70 if ($filtered_to_window) {
  71         Xchat::command("QUERY $filter_window");
  72 }
  73
  74 # information about (default) options used
  75 if ($filter_turned_on) {
  76         Xchat::print("Filter turned ${B}ON${B}\n");
  77 } else {
  78         Xchat::print("Filter turned ${B}OFF${B}\n");
  79 }
  80 if ($limit_to_server) {
  81         Xchat::print("Filter limited to server $limit_to_server\n")
  82 }
  83 if ($use_filter_allow) {
  84         Xchat::print("Filter uses ALLOW rules\n");
  85 }
  86
  87 # ------------------------------------------------------------
  88
  89 my @filter_allow = (
  90         q/^\@search\s/,
  91 );
  92
  93 my @filter_deny = (
  94         q/\@/,
  95         q/^\s*\!/,
  96         q/slot\(s\)/,
  97         #q/~&~&~/,
  98
  99         #xdcc
 100         q/^\#\d+/,
 101
 102         #fserves
 103         q/(?i)fserve.*trigger/,
 104         q/(?i)trigger.*\!/,
 105         q/(?i)trigger.*\/ctcp/,
 106         q/(?i)type\:\s*\!/,
 107         q/(?i)file server online/,
 108
 109         #ftps
 110         q/(?i)ftp.*l\/p/,
 111
 112         #CTCPs
 113         q/SLOTS/,
 114         q/MP3 /,
 115
 116         #messages for when a file is received/failed to receive
 117         q/(?i)DEFINITELY had the right stuff to get/,
 118         q/(?i)has just received/,
 119         q/(?i)I have just received/,
 120
 121         #mp3 play messages
 122         q/is listening to/,
 123         q/\]\-MP3INFO\-\[/,
 124
 125         #spammy scripts
 126         q/\]\-SpR\-\[/,
 127         q/We are BORG/,
 128
 129         #general messages
 130         q/brave soldier in the war/,
 131 );
 132
 133 # return 1 (true) if text given as argument is to be filtered out
 134 sub isFiltered {
 135         my $text = shift;
 136         my $regexp = '';
 137
 138         #strip colour, underline, bold codes, etc.
 139         $text = Xchat::strip_code($text);
 140
 141         if ($use_filter_allow) {
 142                 foreach $regexp (@filter_allow) {
 143                         return 0 if ($text =~ /$regexp/);
 144                 }
 145         }
 146
 147         foreach $regexp (@filter_deny) {
 148                 return 1 if ($text =~ /$regexp/);
 149         }
 150
 151         return 0;
 152 }
 153
 154 #called when someone says something in the channel
 155 #1: address of speaker
 156 #2: PRIVMSG constant
 157 #3: channel
 158 #4: text said (prefixed with :)
 159 sub privmsg_handler {
 160         # $_[0] - array reference containing the IRC message or command
 161         #         and arguments broken into words
 162         # $_[1] - array reference containing the Nth word to the last word
 163         my ($address, $msgtype, $channel) = @{$_[0]};
 164         my ($nick, $user, $host) = ($address =~ /^:(.*?)!(.*?)@(.*)$/);
 165
 166         my $text = $_[1][3]; # Get server message
 167
 168         my $server = Xchat::get_info("host");
 169
 170         return Xchat::EAT_NONE unless $filter_turned_on;
 171         if ($limit_to_server) {
 172                 return Xchat::EAT_NONE unless $server eq $limit_to_server;
 173         }
 174
 175         $text =~ s/^://;
 176
 177         if (isFiltered($text)) {
 178                 if (defined $nick && $filtered_to_window) {
 179                         #Xchat::print($text, $filter_window)
 180
 181                         my $ctx = Xchat::get_context();
 182                         Xchat::set_context($filter_window);
 183                         Xchat::emit_print('Channel Message', $nick, $text);
 184                         Xchat::set_context($ctx);
 185                 }
 186                 #return Xchat::EAT_XCHAT;
 187                 return Xchat::EAT_ALL;
 188         }
 189         return Xchat::EAT_NONE;
 190 }
 191
 192
 193 # ------------------------------------------------------------
 194
 195 sub save_filter {
 196         my ($fh, $tmpfile) = tempfile($filter_file.'.XXXXXX', UNLINK=>1);
 197
 198         unless ($fh) {
 199                 Xchat::print("${B}FILTER:${B} ".
 200                              "Couldn't open temporary file $tmpfile to save filter: $!\n");
 201                 return;
 202         };
 203
 204         Xchat::print("${B}FILTER SAVE >$filter_file${B}\n");
 205         foreach my $regexp (@filter_deny) {
 206                 Xchat::print("/".$regexp."/ saved\n");
 207                 print $fh $regexp."\n";
 208         }
 209
 210         unless (close $fh) {
 211                 Xchat::print("${B}FILTER:${B} Couldn't close file to save filter: $!\n");
 212                 return;
 213         };
 214         #move($tmpfile, $filter_file);
 215         rename($tmpfile, $filter_file);
 216         Xchat::print("${B}FILTER SAVED ----------${B}\n");
 217
 218         return 1;
 219 }
 220
 221 sub load_filter {
 222         my $fh;
 223
 224         Xchat::print("${B}FILTER:${B} ...loading filter patterns\n");
 225         unless (open $fh, '<', $filter_file) {
 226                 Xchat::print("${B}FILTER:${B} Couldn't open file to load filter: $!\n");
 227                 return;
 228         };
 229
 230         @filter_deny = <$fh>;
 231         map (chomp, @filter_deny);
 232
 233         unless (close $fh) {
 234                 Xchat::print("${B}FILTER:${B} Couldn't close file to load filter: $!\n");
 235                 return;
 236         };
 237
 238         Xchat::print("${B}FILTER DENY ----------${B}\n");
 239         for (my $i = 0; $i <= $#filter_deny; $i++) {
 240                 Xchat::print(" [$i]: /".$filter_deny[$i]."/\n");
 241         }
 242         Xchat::print("${B}FILTER DENY ----------${B}\n");
 243 }
 244
 245 sub add_rule ( $ ) {
 246         my $rule = shift;
 247
 248         # always ading rules at the end
 249         push @filter_deny, $rule;
 250 }
 251
 252 sub delete_rule ( $ ) {
 253         my $num = shift || $#filter_deny;
 254
 255         splice @filter_deny, $num, 1;
 256 }
 257
 258 # ============================================================
 259 # ------------------------------------------------------------
 260 # ............................................................
 261
 262 sub cmd_version {
 263         Xchat::print("${B}$scriptName $scriptVersion${B}\n");
 264         Xchat::print(" * URL: http://github.com/jnareb/softsnow-xchat2-filter\n");
 265         Xchat::print(" * URL: http://gitorious.org/projects/softsnow-xchat2-filter\n");
 266         Xchat::print(" * URL: http://repo.or.cz/w/softsnow_xchat2_filter.git\n");
 267 }
 268
 269 sub cmd_status {
 270         my $server = shift;
 271
 272         if ($filter_turned_on) {
 273                 Xchat::print("Filter is turned ${B}ON${B}\n");
 274         } else {
 275                 Xchat::print("Filter is turned ${B}OFF${B}\n");
 276         }
 277         if ($limit_to_server) {
 278                 if ($server eq $limit_to_server) {
 279                         Xchat::print("Filter is limited to ${B}current${B} ".
 280                                      "server $limit_to_server\n");
 281                 } else {
 282                         Xchat::print("Filter is limited to server ".
 283                                      "$limit_to_server != $server\n");
 284                 }
 285         }
 286         if ($use_filter_allow) {
 287                 Xchat::print("Filter is using ALLOW rules (before DENY)\n");
 288         }
 289 }
 290
 291 sub cmd_debug {
 292         Xchat::print("${B}FILTER DEBUG ----------${B}\n");
 293         Xchat::print("Channel:   ".Xchat::get_info("channel")."\n");
 294         Xchat::print("Host:      ".Xchat::get_info("host")."\n");
 295         Xchat::print("Server:    ".Xchat::get_info("server")."\n");
 296         Xchat::print("Server Id: ".Xchat::get_info("id")."\n");
 297         Xchat::print("Network:   ".Xchat::get_info("network")."\n");
 298         Xchat::print("\n");
 299         Xchat::printf("%3u %s rules\n", scalar(@filter_allow), "allow");
 300         Xchat::printf("%3u %s rules\n", scalar(@filter_deny),  "deny");
 301         Xchat::print("${B}FILTER DEBUG ----------${B}\n");
 302 }
 303
 304 sub cmd_server_limit {
 305         my $server = shift;
 306
 307         if ($server) {
 308                 # adding limiting to given (single) server
 309                 if ($limit_to_server) {
 310                         Xchat::print("${B}FILTER:${B} Changing server from $limit_to_server to $server\n");
 311                 } else {
 312                         Xchat::print("${B}FILTER:${B} Limiting filtering to server $server\n");
 313                 }
 314                 $limit_to_server = $server;
 315
 316         } else {
 317                 # removing limiting to server
 318                 if ($limit_to_server) {
 319                         Xchat::print("Filter: Removing limit to server $limit_to_server\n");
 320                 }
 321                 $limit_to_server = '';
 322
 323         }
 324 }
 325
 326 sub cmd_print_rules {
 327         Xchat::print("${B}FILTER PRINT ----------${B}\n");
 328         Xchat::print("${B}ALLOW${B}".($use_filter_allow ? ' (on)' : ' (off)')."\n");
 329
 330         for (my $i = 0; $i <= $#filter_allow; $i++) {
 331                 Xchat::print("[$i]: /".$filter_allow[$i]."/\n");
 332         }
 333         Xchat::print("${B}DENY${B}\n");
 334         for (my $i = 0; $i <= $#filter_deny; $i++) {
 335                 Xchat::print("[$i]: /".$filter_deny[$i]."/\n");
 336         }
 337         Xchat::print("${B}FILTER PRINT ----------${B}\n");
 338 }
 339
 340 sub cmd_add_rule {
 341         my $rule = shift;
 342
 343         if ($rule) {
 344                 add_rule($rule);
 345                 Xchat::print("${B}FILTER RULE [$#filter_deny]:${B} /$rule/\n");
 346         } else {
 347                 Xchat::print("Syntax: ${B}/FILTER ADD ${U}rule${U}${B} to add\n")
 348         }
 349 }
 350
 351 sub cmd_delete_rule {
 352         my $num = shift;
 353
 354         # strip whitespace
 355         $num =~ s/^\s*(.*?)\s*$/$1/g if $num;
 356         SWITCH: {
 357                 unless ($num) {
 358                         Xchat::print("${B}FILTER:${B} deleting /".$filter_deny[-1]."/\n");
 359                         $#filter_deny--;
 360                         Xchat::print("${B}FILTER:${B} deleted successfully last rule\n");
 361                         last SWITCH;
 362                 }
 363                 if ($num !~ /^\d+$/) {
 364                         Xchat::print("${B}FILTER:${B} $num is not a number\n");
 365                         last SWITCH;
 366                 }
 367                 if ($num < 0 || $num > $#filter_deny) {
 368                         Xchat::print("${B}FILTER:${B} $num outside range [0,$#filter_deny]\n");
 369                         last SWITCH;
 370                 }
 371                 # default
 372                 {
 373                         Xchat::print("${B}FILTER:${B} deleting /".$filter_deny[$num]."/\n");
 374                         delete_rule($num);
 375                         Xchat::print("${B}FILTER:${B} deleted successfully rule $num\n");
 376                 }
 377         }
 378 }
 379
 380 sub cmd_show_rule {
 381         my $num = shift;
 382
 383                 $num =~ s/^\s*(.*?)\s*$/$1/g if $num;
 384
 385         if (defined $num && $num !~ /^\d+$/) {
 386                 Xchat::print("${B}FILTER:${B} $num is not a number\n");
 387         }       elsif (defined $num && !defined $filter_deny[$num]) {
 388                 Xchat::print("${B}FILTER:${B} rule $num does not exist\n");
 389         } else {
 390                 Xchat::print("${B}FILTER:${B} ".(defined $num ? "[$num]" : "last").
 391                              " rule /".$filter_deny[defined $num ? $num : -1]."/\n");
 392         }
 393 }
 394
 395 # ============================================================
 396 # ============================================================
 397 # ============================================================
 398
 399 sub filter_command_handler {
 400         my $cmd = $_[0][1]; # 1st parameter (after FILTER)
 401         my $arg = $_[1][2]; # 2nd word to the last word
 402         my $server = Xchat::get_info("host");
 403
 404
 405         if (!$cmd || $cmd =~ /^STATUS$/i) {
 406                 cmd_status($server);
 407
 408         } elsif ($cmd =~ /^ON$/i) {
 409                 $filter_turned_on = 1;
 410                 Xchat::print("Filter turned ${B}ON${B}\n");
 411
 412         } elsif ($cmd =~ /^OFF$/i) {
 413                 $filter_turned_on = 0;
 414                 Xchat::print("Filter turned ${B}OFF${B}\n");
 415
 416         } elsif ($cmd =~ /^SERVER$/i) {
 417                 cmd_server_limit($server);
 418
 419         } elsif ($cmd =~ /^SERVERON$/i) {
 420                 cmd_server_limit($server);
 421
 422                 $filter_turned_on = 1;
 423                 Xchat::print("Filter turned ${B}ON${B}\n");
 424
 425         } elsif ($cmd =~ /^ALL$/i) {
 426                 cmd_server_limit(undef);
 427
 428         } elsif ($cmd =~ /^HELP$/i) {
 429                 Xchat::print($filter_help);
 430                 Xchat::print($filterwindow_help);
 431
 432         } elsif ($cmd =~ /^VERSION$/i) {
 433                 cmd_version();
 434
 435         } elsif ($cmd =~ /^DEBUG$/i || $cmd =~ /^INFO$/i) {
 436                 cmd_debug();
 437
 438         } elsif ($cmd =~ /^(?:PRINT|LIST)$/i) {
 439                 cmd_print_rules();
 440
 441         } elsif ($cmd =~ /^ALLOW$/i) {
 442                 $use_filter_allow = !$use_filter_allow;
 443                 Xchat::print("${B}FILTER:${B} ALLOW rules ".
 444                              ($use_filter_allow ? "enabled" : "disabled")."\n");
 445
 446         } elsif ($cmd =~ /^ADD$/i) {
 447                 cmd_add_rule($arg);
 448
 449         } elsif ($cmd =~ /^DEL(?:ETE)$/i) {
 450                 cmd_delete_rule($arg);
 451
 452         } elsif ($cmd =~ /^SHOW$/i) {
 453                 cmd_show_rule($arg);
 454
 455         } elsif ($cmd =~ /^SAVE$/i) {
 456                 save_filter();
 457                 Xchat::print("${B}FILTER:${B} saved DENY rules to $filter_file\n");
 458
 459         } elsif ($cmd =~ /^(RE)?LOAD$/i) {
 460                 load_filter();
 461                 Xchat::print("${B}FILTER:${B} loaded DENY rules from $filter_file\n");
 462
 463         } else {
 464                 Xchat::print("Unknown command ${B}/FILTER $_[1][1]${B}\n") if $cmd;
 465         }
 466         return 1;
 467 }
 468
 469 sub filterwindow_command_handler {
 470         my $cmd = $_[0][1]; # 1st parameter (after FILTER)
 471         #my $arg = $_[1][2]; # 2nd word to the last word
 472
 473         if (!$cmd) {
 474                 Xchat::print("${B}${U}USAGE:${U} /FILTERWINDOW ON|OFF${B}\n");
 475
 476         } elsif ($cmd =~ /^ON$/i) {
 477                 Xchat::command("QUERY $filter_window");
 478                 Xchat::print("${B}----- START LOGGING FILTERED CONTENTS -----${B}\n",
 479                              $filter_window)
 480                         if !$filtered_to_window;
 481
 482                 $filtered_to_window = 1;
 483                 Xchat::print("Show filtered content in ${B}$filter_window${B}\n");
 484
 485         } elsif ($cmd =~ /^OFF$/i) {
 486                 Xchat::print("${B}----- STOP LOGGING FILTERED CONTENTS -----${B}\n",
 487                              $filter_window)
 488                         if $filtered_to_window;
 489                 #Xchat::command("CLOSE", $FilterWindow);
 490
 491                 $filtered_to_window = 1;
 492                 Xchat::print("Don't show filtered content in ${B}$filter_window${B}\n");
 493
 494         } elsif ($cmd =~ /^HELP$/i) {
 495                 Xchat::print($filterwindow_help);
 496
 497         } else {
 498                 Xchat::print("Unknown command ${B}/FILTERWINDOW $_[1][1]${B}\n") if $cmd;
 499                 Xchat::print("${B}${U}USAGE:${U} /FILTERWINDOW ON|OFF${B}\n");
 500         }
 501
 502         return 1;
 503 }
 504
 505 # ======================================================================
 506 # ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 507 # ----------------------------------------------------------------------
 508
 509 Xchat::print("${B}$scriptName $scriptVersion${B} loaded\n");
 510
 511 1;