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 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
|
#!/usr/bin/perl
# tircd - An ircd proxy to the Twitter API
# Copyright (c) 2009 Chris Nelson <tircd@crazybrain.org>
# tircd is free software; you can redistribute it and/or modify it under the terms of either:
# a) the GNU General Public License as published by the Free Software Foundation
# b) the "Artistic License"
use strict;
use JSON::Any;
use Net::Twitter::Lite;
use Time::Local;
use File::Glob ':glob';
use IO::File;
use LWP::UserAgent;
use Storable;
use POE qw(Component::Server::TCP Filter::Stackable Filter::Map Filter::IRCD);
use URI qw/host/;
# @Olatho - issue 45
use HTML::Entities;
my $VERSION = 0.8;
# consumer key/secret in the executable instead of config because it should not be edited by user
my $tw_oauth_con_key = "4AQca4GFiWWaifUknq35Q";
my $tw_oauth_con_sec = "VB0exmHlErkx4GUUsXvoR4bqaXi56Rl43NL1Z9Q";
# I have no idea what the minimum Net::Twitter::Lite version is
#Do some sanity checks on the environment and warn if not what we want
#if ($Net::Twitter::Lite::VERSION < 2.10) {
# print "Warning: Your system has an old version of Net::Twitter::Lite. Please upgrade to the current version.\n";
#}
my $j = JSON::Any->new;
if ($j->handlerType eq 'JSON::Syck') {
print "Warning: Your system is using JSON::Syck. This will cause problems with character encoding. Please install JSON::PP or JSON::XS.\n";
}
#load and parse our own very simple config file
#didn't want to introduce another module requirement to parse XML or a YAML file
my $config_file = '/etc/tircd.cfg';
if ($ARGV[0]) {
$config_file = $ARGV[0];
} elsif (-e 'tircd.cfg') {
$config_file = 'tircd.cfg';
} elsif (-e bsd_glob('~',GLOB_TILDE | GLOB_ERR).'/.tircd') {
$config_file = bsd_glob('~',GLOB_TILDE | GLOB_ERR).'/.tircd';
}
open(C,$config_file) || die("$0: Unable to load config file ($config_file): $!\n");
my %config = ();
while (<C>) {
chomp;
next if /^#/ || /^$/;
my ($key,$value) = split(/\s/,$_,2);
$config{$key} = $value;
}
close(C);
#config file backwards compatibility
$config{'timeline_count'} = 20 if !exists $config{'timeline_count'};
#storage for connected users
my %users;
#setup our filter to process the IRC messages, jacked from the Filter::IRCD docs
my $filter = POE::Filter::Stackable->new();
$filter->push( POE::Filter::Line->new( InputRegexp => '\015?\012', OutputLiteral => "\015\012" ));
#twitter's json feed escapes < and >, let's fix that
$filter->push( POE::Filter::Map->new(Code => sub {
local $_ = shift;
# @Olatho - Issue 45 - see also issue 50
decode_entities($_);
return $_;
}));
if ($config{'debug'} > 1) {
$filter->push(POE::Filter::IRCD->new(debug => 1));
} else {
$filter->push(POE::Filter::IRCD->new(debug => 0));
}
# if configured to use SSL, and no env vars yet defined, set to config settings
if ($config{'use_ssl'} == 1 && !($ENV{'HTTPS_CA_FILE'} || $ENV{'HTTPS_CA_DIR'})) {
if ($config{'https_ca_file'} and -e $config{'https_ca_file'}) {
$ENV{'HTTPS_CA_FILE'} = $config{'https_ca_file'};
} elsif ($config{'https_ca_dir'} && -d $config{'https_ca_dir'}) {
$ENV{'HTTPS_CA_DIR'} = $config{'https_ca_dir'};
}
}
#if needed setup our logging sesstion
if ($config{'logtype'} ne 'none') {
POE::Session->create(
inline_states => {
_start => \&logger_setup,
log => \&logger_log
},
args => [$config{'logtype'},$config{'logfile'}]
);
}
#setup our 'irc server'
POE::Component::Server::TCP->new(
Alias => "tircd",
Address => $config{'address'},
Port => $config{'port'},
InlineStates => {
PASS => \&irc_pass,
NICK => \&irc_nick,
USER => \&irc_user,
MOTD => \&irc_motd,
MODE => \&irc_mode,
JOIN => \&irc_join,
PART => \&irc_part,
WHO => \&irc_who,
WHOIS => \&irc_whois,
PRIVMSG => \&irc_privmsg,
STATS => \&irc_stats,
INVITE => \&irc_invite,
KICK => \&irc_kick,
QUIT => \&irc_quit,
PING => \&irc_ping,
AWAY => \&irc_away,
TOPIC => \&irc_topic,
'#twitter' => \&channel_twitter,
server_reply => \&irc_reply,
user_msg => \&irc_user_msg,
twitter_api_error => \&twitter_api_error,
twitter_timeline => \&twitter_timeline,
twitter_direct_messages => \&twitter_direct_messages,
twitter_search => \&twitter_search,
login => \&tircd_login,
getfriend => \&tircd_getfriend,
remfriend => \&tircd_remfriend,
updatefriend => \&tircd_updatefriend,
getfollower => \&tircd_getfollower,
verify_ssl => \&tircd_verify_ssl,
basicauth_login => \&twitter_basic_login,
setup_authenticated_user => \&tircd_setup_authenticated_user,
oauth_login_begin => \&twitter_oauth_login_begin,
oauth_login_finish => \&twitter_oauth_login_finish,
oauth_pin_ask => \&twitter_oauth_pin_ask,
oauth_pin_entry => \&twitter_oauth_pin_entry,
no_pin_received => \&tircd_oauth_no_pin_received,
},
ClientFilter => $filter,
ClientInput => \&irc_line,
ClientConnected => \&tircd_connect,
ClientDisconnected => \&tircd_cleanup,
Started => \&tircd_setup
);
$poe_kernel->run();
exit 0;
########## STARTUP FUNCTIONS BEGIN
sub tircd_setup {
$_[KERNEL]->call('logger','log',"tircd $VERSION started, using config from: $config_file.");
$_[KERNEL]->call('logger','log',"Listening on: $config{'address'}:$config{'port'}.");
}
#setup our logging session
sub logger_setup {
my ($kernel, $heap, $type, $file) = @_[KERNEL, HEAP, ARG0, ARG1];
$_[KERNEL]->alias_set('logger');
my $handle = 0;
if ($type eq 'file') {
$handle = IO::File->new(">>$file");
} elsif ($type eq 'stdout') {
$handle = \*STDOUT;
} elsif ($type eq 'stderr') {
$handle = \*STDERR;
}
if ($handle) {
#Win32 seems to blow up when trying to set FIONBIO on STDOUT/ERR
$heap->{'file'} = ($^O eq 'MSWin32' && $type ne 'file') ? $handle : POE::Wheel::ReadWrite->new( Handle => $handle );
}
}
########## 'INTERNAL' UTILITY FUNCTIONS
#log a message
sub logger_log {
my ($heap, $msg, $from) = @_[HEAP, ARG0, ARG1];
return if ! $heap->{'file'};
$from = "[$from] " if defined $from;
my $stamp = '['.localtime().'] ';
if (ref $heap->{'file'} eq 'POE::Wheel::ReadWrite') {
$heap->{'file'}->put("$stamp$from$msg");
} else {
$heap->{'file'}->print("$stamp$from$msg\n");
}
}
#trap twitter api errors
sub twitter_api_error {
my ($kernel,$heap, $msg, $error) = @_[KERNEL, HEAP, ARG0, ARG1];
if ($config{'debug'}) {
$kernel->post('logger','log',$error->message().' '.$error->code().' '.$error,'debug/twitter_api_error');
}
$kernel->post('logger','log',$msg.' ('.$error->code() .' from Twitter API).',$heap->{'username'});
if ($error->code() == 400) {
$msg .= ' Twitter API limit reached.';
} else {
$msg .= ' Twitter Fail Whale.';
}
$kernel->yield('server_reply',461,'#twitter',$msg);
}
#update a friend's info in the heap
sub tircd_updatefriend {
my ($heap, $new) = @_[HEAP, ARG0];
foreach my $friend (@{$heap->{'friends'}}) {
if ($friend->{'id'} == $new->{'id'}) {
$friend = $new;
return 1;
}
}
return 0;
}
#check to see if a given friend exists, and return it
sub tircd_getfriend {
my ($heap, $target) = @_[HEAP, ARG0];
foreach my $friend (@{$heap->{'friends'}}) {
if ($friend->{'screen_name'} eq $target) {
return $friend;
}
}
return 0;
}
sub tircd_getfollower {
my ($heap, $target) = @_[HEAP, ARG0];
foreach my $follower (@{$heap->{'followers'}}) {
if ($follower->{'screen_name'} eq $target) {
return $follower;
}
}
return 0;
}
sub tircd_remfriend {
my ($heap, $target) = @_[HEAP, ARG0];
my @tmp = ();
foreach my $friend (@{$heap->{'friends'}}) {
if ($friend->{'screen_name'} ne $target) {
push(@tmp,$friend);
}
}
$heap->{'friends'} = \@tmp;
}
#called once we have a user/pass, attempts to auth with twitter
sub tircd_login {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
if ($heap->{'twitter'}) { #make sure we aren't called twice
return;
}
$heap->{'nt_params'}{'source'} = "tircd";
# use SSL?
if ($config{'use_ssl'}) {
$heap->{'nt_params'}{'ssl'} = 1;
# verify_ssl will drop user if SSL checks fail
return unless($kernel->call($_[SESSION],'verify_ssl'));
}
# kick off specified authentication flow
# username oauth is (currently) reserved on twitter, can be used to pick login
if ($heap->{'username'} =~ /^oauth$/i) {
return $kernel->call($_[SESSION],'oauth_login_begin');
} else {
return $kernel->call($_[SESSION],'basicauth_login');
}
}
# Login methods
# basic auth code from original tircd_login sub
sub twitter_basic_login {
my ($kernel, $heap) = @_[KERNEL, HEAP];
$heap->{'nt_params'}{'username'} = $heap->{'username'};
$heap->{'nt_params'}{'password'} = $heap->{'password'};
#start up the twitter interface, and see if we can connect with the given NICK/PASS INFO
$heap->{'twitter'} = Net::Twitter::Lite->new(%{ $heap->{'nt_params'} });
unless (eval{ $heap->{'twitter'}->verify_credentials() }) {
$kernel->post('logger','log','Unable to login to Twitter with the supplied credentials.',$heap->{'username'});
$kernel->yield('server_reply',462,'Unable to login to Twitter with the supplied credentials.');
$kernel->yield('shutdown'); #disconnect 'em if we cant
return;
}
$kernel->post('logger','log','Successfully authenticated with Twitter.',$heap->{'username'});
$kernel->yield('setup_authenticated_user');
return 1;
}
# called by tircd_login when username set to oauth
sub twitter_oauth_login_begin {
my ($kernel, $heap) = @_[KERNEL, HEAP];
$heap->{'nt_params'}{'consumer_key'} = $tw_oauth_con_key;
$heap->{'nt_params'}{'consumer_secret'} = $tw_oauth_con_sec;
eval "use Net::OAuth 0.16";
if ($@) {
$kernel->yield('server_reply',463,'Net::OAuth >= 0.16 is not installed');
$kernel->yield('server_reply',463,'OAuth authentication requires Net::OAuth version 0.16 or greater.');
$kernel->yield('shutdown');
}
$kernel->yield('server_reply',463,'OAuth authentication selected.');
$heap->{'twitter'} = Net::Twitter::Lite->new(%{$heap->{'nt_params'}});
# if tokens in config, try to re-use
# TODO allow users to specify no store of access tokens
if ($heap->{'config'}->{'access_token'} && $heap->{'config'}->{'access_token_secret'} && $heap->{'config'}->{'username'}) {
$heap->{'twitter'}->access_token($heap->{'config'}->{'access_token'});
$heap->{'twitter'}->access_token_secret($heap->{'config'}->{'access_token_secret'});
$heap->{'username'} = $heap->{'config'}->{'username'};
return if $kernel->call($_[SESSION],'oauth_login_finish');
}
unless($heap->{'twitter'}->authorized) {
$kernel->call($_[SESSION],'oauth_pin_ask');
}
return 1;
}
# direct user to pin site
sub twitter_oauth_pin_ask {
my ($kernel, $heap) = @_[KERNEL,HEAP];
$kernel->yield('server_reply',463,"Please authorize this connection at:");
$kernel->yield('server_reply',463,$heap->{'twitter'}->get_authentication_url);
$kernel->yield('server_reply',463,"To continue connecting, type /stats pin <PIN>, where <PIN> is the PIN returned by the twitter authorize page.");
# half an hour until disconnect
$kernel->alarm('no_pin_received',time() + 1800);
return 1;
}
# received pin msg
sub twitter_oauth_pin_entry {
my ($kernel, $pin) = @_[KERNEL, ARG0];
# clear ask timeout alarm
$kernel->alarm('no_pin_received');
return $kernel->call($_[SESSION],'oauth_login_finish',$pin);
}
sub twitter_oauth_login_finish {
my ($kernel, $heap, $pin) = @_[KERNEL, HEAP, ARG0];
# make token ask if pin provided
if ($pin) {
my ($access_token, $access_token_sec, $user_id, $username) = eval { $heap->{'twitter'}->request_access_token(verifier=>$pin) };
if ($@) {
if ($@ =~ m/401/) {
$kernel->yield('server_reply',510,'Unable to authorize with this PIN. Please try again.');
} else {
$kernel->yield('server_reply',511,'Unknown error while authorizing. Please try again.');
}
$kernel->yield('oauth_pin_ask');
return;
}
# check if already logged in
if (exists $users{$username}) {
$kernel->yield('server_reply',436,$username,'You are already connected to Twitter with this username.');
$kernel->yield('shutdown');
return 1;
}
# store tokens and user info in config for later use.
$heap->{'config'}->{'access_token'} = $access_token;
$heap->{'config'}->{'access_token_secret'} = $access_token_sec;
$heap->{'config'}->{'user_id'} = $user_id;
$heap->{'config'}->{'username'} = $username;
$heap->{'username'} = $username;
}
# make sure we're happy, otherwise re-try PIN ask
unless($heap->{'twitter'}->authorized) {
$kernel->post('logger','log','Unable to retrieve access tokens for entered PIN.');
$kernel->yield('server_reply',462,'Invalid PIN. Re-check PIN and try again.');
$kernel->yield('oauth_pin_ask');
return;
}
$kernel->yield('server_reply',399,'PIN accepted.');
$kernel->yield('setup_authenticated_user');
return 1;
}
sub tircd_setup_authenticated_user {
my ($kernel, $heap) = @_[KERNEL, HEAP];
#load our configs from disk if they exist
if (-d $config{'storage_path'}) {
$heap->{'config'} = eval {retrieve($config{'storage_path'} . '/' . $heap->{'username'} . '.config');};
$heap->{'channels'} = eval {retrieve($config{'storage_path'} . '/' . $heap->{'username'} . '.channels');};
}
my @user_settings = qw(update_timeline update_directs timeline_count long_messages min_length join_silent filter_self shorten_urls convert_irc_replies);
# copy base config for user if prior config failed to exist/retrieve
if (!$heap->{'config'}) {
my %copy = %config;
$heap->{'config'} = \%copy;
}
foreach my $s (@user_settings) {
if (!$heap->{'config'}->{$s}) {
$heap->{'config'}->{$s} = $config{$s};
}
}
foreach my $k (keys %{$heap->{'config'}}) {
if (!grep($_ eq $k, @user_settings)) {
delete $heap->{'config'}->{$k};
}
}
if (!$heap->{'channels'}) {
$heap->{'channels'} = {};
}
#we need this for the tinyurl support and others
$heap->{'ua'} = LWP::UserAgent->new;
$heap->{'ua'}->timeout(10);
$heap->{'ua'}->env_proxy();
# allow channel joining
$heap->{'authenticated'} = 1;
#stash the username in a list to keep 'em from rejoining
$users{$heap->{'username'}} = 1;
#some clients need this shit
$kernel->yield('server_reply','001',"Welcome to tircd $heap->{'username'}");
$kernel->yield('server_reply','002',"Your host is tircd running version $VERSION");
$kernel->yield('server_reply','003',"This server was created just for you!");
$kernel->yield('server_reply','004',"tircd $VERSION i int");
#show 'em the motd
$kernel->yield('MOTD');
}
sub tircd_oauth_no_pin_received {
my ($kernel, $heap) = @_[KERNEL, HEAP];
# we didn't receive a pin in time
$kernel->post('logger','log','No PIN entered, disconnecting user: ',$heap->{'username'});
$kernel->yield('server_reply',532,'Never received a PIN. Disconnecting');
$kernel->yield('shutdown'); #disconnect 'em if we cant
return;
}
sub tircd_verify_ssl {
my($kernel) = @_[KERNEL];
# unless we have a bundle or directory of certs to verify against, ssl is b0rked
unless($ENV{'HTTPS_CA_FILE'} or $ENV{'HTTPS_CA_DIR'}) {
$kernel->yield('logger','log',"You must provide the environment variable HTTPS_CA_FILE or HTTPS_CA_DIR before starting tircd.pl in order to verify SSL certificates.");
$kernel->yield('server_reply',462,'Unable to verify SSL certificate');
$kernel->yield('shutdown'); #disconnect 'em if we cant
return;
}
# check ssl cert using LWP
my $api_check = Net::Twitter::Lite->new;
my $sslcheck = LWP::UserAgent->new;
my $apiurl = URI->new($api_check->{'apiurl'});
# second level domain, aka domain.tld. if this is present in the certificate, we are happy
my $SLD = $apiurl->host;
$SLD =~ s/.*\.([^.]*\.[^.]*)/$1/;;
# if-ssl-cert-subject causes the certificate subject line to be checked against the regex in its value
# upon checking the certificate, it will cancel the request and set the HTTP::Response is_error to 1 for us
$sslcheck->default_header("If-SSL-Cert-Subject" => "CN=(.*\.){0,1}$SLD");
# knock politely
my $sslresp = $sslcheck->get($apiurl);
# cert failed to verify against local bundle/ca_dir
if( $sslresp->header('client-ssl-warning') ) {
$kernel->yield('logger','log',"Unable to verify server certificate against local authority.");
$kernel->yield('server_reply',462,'Unable to verify SSL certificate.');
$kernel->yield('shutdown');
return;
}
# cert response failed to be for expected domain
if( $sslresp->is_error && $sslresp->code == 500 ) {
$kernel->yield('logger','log',"Hostname (CN) of SSL certificate did not match domain being accessed, someone is doing something nasty!");
$kernel->yield('server_reply',462,'SSL certificate has invalid Common Name (CN).');
$kernel->yield('shutdown');
return;
}
# all SLL checks passed
return 1;
}
sub tircd_connect {
my ($kernel, $heap) = @_[KERNEL, HEAP];
$kernel->post('logger','log',$heap->{'remote_ip'}.' connected.');
}
sub tircd_cleanup {
my ($kernel, $heap) = @_[KERNEL, HEAP];
$kernel->post('logger','log',$heap->{'remote_ip'}.' disconnected.',$heap->{'username'});
# stop the oauth no pin entry alarm
$kernel->alarm('no_pin_received');
#delete the username
delete $users{$heap->{'username'}};
#remove our timers so the session will die
$kernel->delay('twitter_timeline');
$kernel->delay('twitter_direct_messages');
# if storage_path directory doesn't exist, attempt to create
unless ( -e $config{'storage_path'} && -d $config{'storage_path'} ) {
unless (mkdir ($config{'storage_path'})) {
$kernel->post('logger','log','Was unable to create storage_path at ' . $config{'storage_path'} . ' .' . $!);
}
}
#if defined, save our data for next time
if ($config{'storage_path'} && -d $config{'storage_path'} && -w $config{'storage_path'}) {
#mark all channels as not joined for the next reload
foreach my $chan (keys %{$heap->{'channels'}}) {
$heap->{'channels'}->{$chan}->{'joined'} = 0;
}
eval {store($heap->{'config'},$config{'storage_path'} . '/' . $heap->{'username'} . '.config');};
eval {store($heap->{'channels'},$config{'storage_path'} . '/' . $heap->{'username'} . '.channels');};
} else {
$kernel->post('logger','log','storage_path is not set or is not writable, not saving configuration.',$heap->{'username'});
}
$kernel->yield('shutdown');
}
########## 'INTERNAL' IRC I/O FUNCTIONS
#called everytime we get a line from an irc server
#trigger an event and move on, the ones we care about will get trapped
sub irc_line {
my ($kernel, $data) = @_[KERNEL, ARG0];
if ($config{'debug'}) {
if (!$data->{'params'}) {
$data->{'params'} = [];
}
$kernel->post('logger','log',$data->{'prefix'}.' '.$data->{'command'}.' '.join(' ',@{$data->{'params'}}),'debug/irc_line');
}
$kernel->yield($data->{'command'},$data);
}
#send a message that looks like it came from a user
sub irc_user_msg {
my ($kernel, $heap, $code, $username, @params) = @_[KERNEL, HEAP, ARG0, ARG1, ARG2..$#_];
foreach my $p (@params) { #fix multiline tweets, submitted a patch to Filter::IRCD to fix this in the long term
$p =~ s/\n/ /g;
}
if ($config{'debug'}) {
$kernel->post('logger','log',$username.' '.$code.' '.join(' ',@params),'debug/irc_user_msg');
}
$heap->{'client'}->put({
command => $code,
prefix => "$username!$username\@twitter",
params => \@params
});
}
#send a message that comes from the server
sub irc_reply {
my ($kernel, $heap, $code, @params) = @_[KERNEL, HEAP, ARG0, ARG1..$#_];
foreach my $p (@params) {
$p =~ s/\n/ /g;
}
if ($code ne 'PONG' && $code ne 'MODE' && $code != 436) {
unshift(@params,$heap->{'username'}); #prepend the target username to the message;
}
if ($config{'debug'}) {
$kernel->post('logger','log',':tircd '.$code.' '.join(' ',@params),'debug/irc_reply');
}
$heap->{'client'}->put({
command => $code,
prefix => 'tircd',
params => \@params
});
}
########### IRC EVENT FUNCTIONS
sub irc_pass {
my ($heap, $data) = @_[HEAP, ARG0];
$heap->{'password'} = $data->{'params'}[0]; #stash the password for later
}
sub irc_nick {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
if ($heap->{'username'}) { #if we've already got their nick, don't let them change it
$kernel->yield('server_reply',433,'Changing nicks once connected is not currently supported.');
return;
}
if (exists $users{$data->{'params'}[0]}) {
$kernel->yield('server_reply',436,$data->{'params'}[0],'You are already connected to Twitter with this username.');
$kernel->yield('shutdown');
return;
}
$heap->{'username'} = $data->{'params'}[0]; #stash the username for later
if ($heap->{'username'} && $heap->{'password'} && !$heap->{'twitter'}) {
$kernel->yield('login');
}
}
sub irc_user {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
if ($heap->{'username'} && $heap->{'password'} && !$heap->{'twitter'}) {
$kernel->yield('login');
}
}
#return the MOTD
sub irc_motd {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
$kernel->yield('server_reply',375,'- tircd Message of the Day -');
my $ua = LWP::UserAgent->new;
$ua->timeout(5);
$ua->env_proxy();
my $res = $ua->get('http://tircd.googlecode.com/svn/trunk/motd.txt');
if (!$res->is_success) {
$kernel->yield('server_reply',372,"- Unable to get the MOTD.");
} else {
my @lines = split(/\n/,$res->content);
foreach my $line (@lines) {
$kernel->yield('server_reply',372,"- $line");
}
}
$kernel->yield('server_reply',376,'End of /MOTD command.');
}
sub irc_join {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
unless($heap->{'authenticated'}) {
$kernel->yield('server_reply',508,"Unable to join ", $data->{'params'}[0],".");
$kernel->yield('server_reply',509,"Connection not yet authorized.");
return;
}
my @chans = split(/\,/,$data->{'params'}[0]);
foreach my $chan (@chans) {
$chan =~ s/\s//g;
#see if we've registered an event handler for a 'special channel' (currently only #twitter)
if ($kernel->call($_[SESSION],$chan,$chan)) {
next;
}
#we might have something saved already, if not prep a new channel
if (!exists $heap->{'channels'}->{$chan} ) {
$heap->{'channels'}->{$chan} = {};
$heap->{'channels'}->{$chan}->{'names'}->{$heap->{'username'}} = '@';
}
$heap->{'channels'}->{$chan}->{'joined'} = 1;
#otherwise, prep a blank channel
$kernel->yield('user_msg','JOIN',$heap->{'username'},$chan);
$kernel->yield('server_reply',332,$chan,"$chan");
$kernel->yield('server_reply',333,$chan,'tircd!tircd@tircd',time());
#send the /NAMES info
my $all_users = '';
foreach my $name (keys %{$heap->{'channels'}->{$chan}->{'names'}}) {
$all_users .= $heap->{'channels'}->{$chan}->{'names'}->{$name} . $name .' ';
}
$kernel->yield('server_reply',353,'=',$chan,$all_users);
$kernel->yield('server_reply',366,$chan,'End of /NAMES list');
#restart the searching
if ($heap->{'channels'}->{$chan}->{'topic'}) {
$kernel->yield('user_msg','TOPIC',$heap->{'username'},$chan,$heap->{'channels'}->{$chan}->{'topic'});
$kernel->yield('twitter_search',$chan);
}
}
}
sub irc_part {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $chan = $data->{'params'}[0];
if ($heap->{'channels'}->{$chan}->{'joined'}) {
delete $heap->{'channels'}->{$chan};
$kernel->yield('user_msg','PART',$heap->{'username'},$chan);
} else {
$kernel->yield('server_reply',442,$chan,"You're not on that channel");
}
}
sub irc_mode { #ignore all mode requests except ban which is a block (send back the appropriate message to keep the client happy)
#this whole thing is messy as hell, need to refactor this function
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $target = $data->{'params'}[0];
my $mode = $data->{'params'}[1];
my $opts = $data->{'params'}[2];
#extract the nick from the banmask
my ($nick,$host) = split(/\!/,$opts,2);
$nick =~ s/\*//g;
if (!$nick) {
$host =~ s/\*//g;
if ($host =~ /(.*)\@twitter/) {
$nick = $1;
}
}
if ($target =~ /^\#/) {
if ($mode eq 'b') {
$kernel->yield('server_reply',368,$target,'End of channel ban list');
return;
}
if ($target eq '#twitter') {
if ($mode eq '+b' && $target eq '#twitter') {
my $user = eval { $heap->{'twitter'}->create_block($nick) };
my $error = $@;
if ($user) {
$kernel->yield('user_msg','MODE',$heap->{'username'},$target,$mode,$opts);
} else {
if (ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to block user.',$error);
} else {
$kernel->yield('server_reply',401,$nick,'No such nick/channel');
}
}
return;
} elsif ($mode eq '-b' && $target eq '#twitter') {
my $user = eval { $heap->{'twitter'}->destroy_block($nick) };
my $error = $@;
if ($user) {
$kernel->yield('user_msg','MODE',$heap->{'username'},$target,$mode,$opts);
} else {
if (ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to unblock user.',$error);
} else {
$kernel->yield('server_reply',401,$nick,'No such nick/channel');
}
}
return;
}
}
if (!$mode) {
$kernel->yield('server_reply',324,$target,"+t");
}
return;
}
$kernel->yield('user_msg','MODE',$heap->{'username'},$target,'+i');
}
sub irc_who {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $target = $data->{'params'}[0];
if ($target =~ /^\#/) {
if (exists $heap->{'channels'}->{$target}) {
foreach my $name (keys %{$heap->{'channels'}->{$target}->{'names'}}) {
if (my $friend = $kernel->call($_[SESSION],'getfriend',$name)) {
$kernel->yield('server_reply',352,$target,$name,'twitter','tircd',$name,'G'.$heap->{'channels'}->{$target}->{'names'}->{$name},"0 $friend->{'name'}");
}
}
}
} else { #only support a ghetto version of /who right now, /who ** and what not won't work
if (my $friend = $kernel->call($_[SESSION],'getfriend',$target)) {
$kernel->yield('server_reply',352,'*',$friend->{'screen_name'},'twitter','tircd',$friend->{'screen_name'}, "G","0 $friend->{'name'}");
}
}
$kernel->yield('server_reply',315,$target,'End of /WHO list');
}
sub irc_whois {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $target = $data->{'params'}[0];
my $friend = $kernel->call($_[SESSION],'getfriend',$target);
my $isfriend = 1;
my $error;
if (!$friend) {#if we don't have their info already try to get it from twitter, and track it for the end of this function
$friend = eval { $heap->{'twitter'}->show_user($target) };
$error = $@;
$isfriend = 0;
}
if (ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() == 404) {
$kernel->yield('server_reply',402,$target,'No such server');
return;
}
if (!$friend && ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to get user information.',$error);
return;
}
if ($friend) {
$kernel->post('logger','log',"Received user information for $target from Twitter.",$heap->{'username'});
$kernel->yield('server_reply',311,$target,$target,'twitter','*',$friend->{'name'});
#send a bunch of 301s to convey all the twitter info, not sure if this is totally legit, but the clients I tested with seem ok with it
if ($friend->{'location'}) {
$kernel->yield('server_reply',301,$target,"Location: $friend->{'location'}");
}
if ($friend->{'url'}) {
$kernel->yield('server_reply',301,$target,"Web: $friend->{'url'}");
}
if ($friend->{'description'}) {
$kernel->yield('server_reply',301,$target,"Bio: $friend->{'description'}");
}
if ($friend->{'status'}->{'text'}) {
$kernel->yield('server_reply',301,$target,"Last Update: ".$friend->{'status'}->{'text'});
}
if ($target eq $heap->{'username'}) { #if it's us, then add the rate limit info to
my $rate = eval { $heap->{'twitter'}->rate_limit_status() };
$kernel->yield('server_reply',301,$target,'API Usage: '.($rate->{'hourly_limit'}-$rate->{'remaining_hits'})." of $rate->{'hourly_limit'} calls used.");
$kernel->post('logger','log','Current API usage: '.($rate->{'hourly_limit'}-$rate->{'remaining_hits'})." of $rate->{'hourly_limit'}",$heap->{'username'});
}
#treat their twitter client as the server
my $server; my $info;
if ($friend->{'status'}->{'source'} =~ /\<a href="(.*)"\>(.*)\<\/a\>/) { #not sure this regex will work in all cases
$server = $2;
$info = $1;
} else {
$server = 'web';
$info = 'http://www.twitter.com/';
}
$kernel->yield('server_reply',312,$target,$server,$info);
#set their idle time, to the time since last message (if we have one, the api won't return the most recent message for users who haven't updated in a long time)
my $diff = 0;
my %mon2num = qw(Jan 0 Feb 1 Mar 2 Apr 3 May 4 Jun 5 Jul 6 Aug 7 Sep 8 Oct 9 Nov 10 Dec 11);
if ($friend->{'status'}->{'created_at'} =~ /\w+ (\w+) (\d+) (\d+):(\d+):(\d+) [+|-]\d+ (\d+)/) {
my $date = timegm($5,$4,$3,$2,$mon2num{$1},$6);
$diff = time()-$date;
}
$kernel->yield('server_reply',317,$target,$diff,'seconds idle');
my $all_chans = '';
foreach my $chan (keys %{$heap->{'channels'}}) {
if (exists $heap->{'channels'}->{$chan}->{'names'}->{$friend->{'screen_name'}}) {
$all_chans .= $heap->{'channels'}->{$chan}->{'names'}->{$friend->{'screen_name'}}."$chan ";
}
}
if ($all_chans ne '') {
$kernel->yield('server_reply',319,$target,$all_chans);
}
}
$kernel->yield('server_reply',318,$target,'End of /WHOIS list');
}
sub irc_stats {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $key = $data->{'params'}[0];
my $val = $data->{'params'}[1];
$key = '--' if (!$key || $key eq 'm');
if ($key eq '--') {
$kernel->yield('server_reply',212,$key,"Current config settings:");
foreach my $k (sort keys %{$heap->{'config'}}) {
$kernel->yield('server_reply',212,$key," $k: ".$heap->{'config'}->{$k});
}
$kernel->yield('server_reply',212,$key,"Use '/stats <key> <value>' to change a setting.");
$kernel->yield('server_reply',212,$key,"Example: /stats join_silent 1");
} elsif ($key =~ m/pin/i) {
$kernel->yield('oauth_pin_entry',$val);
return;
} else {
if (exists $heap->{'config'}->{$key}) {
$heap->{'config'}->{$key} = $val;
$kernel->yield('server_reply',212,$key,"set to $val");
}
}
$kernel->yield('server_reply',219,$key,'End of /STATS request');
}
sub irc_privmsg {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $target = $data->{'params'}[0];
my $msg = $data->{'params'}[1];
#handle /me or ACTION requests properly
#this begins the slipperly slope of manipulating user input
$msg =~ s/\001ACTION (.*)\001/\*$1\*/;
if ($heap->{'config'}->{'long_messages'} eq 'split' && length($msg) > 140) {
my @parts = $msg =~ /(.{1,140})/g;
if (length($parts[$#parts]) < $heap->{'config'}->{'min_length'}) {
$kernel->yield('server_reply',404,$target,"The last message would only be ".length($parts[$#parts]).' characters long. Your message was not sent.');
return;
}
#if we got this far, recue the split messages
foreach my $part (@parts) {
$data->{'params'}[1] = $part;
$kernel->call($_[SESSION],'PRIVMSG',$data);
}
return;
}
if ($target =~ /^#/) {
if (!exists $heap->{'channels'}->{$target}) {
$kernel->yield('server_reply',404,$target,'Cannot send to channel');
return;
} else {
$target = '#twitter'; #we want to force all topic changes and what not into twitter for now
}
#shorten the URL
if (eval("require URI::Find;") && $heap->{'config'}->{'shorten_urls'}) {
my $finder = URI::Find->new(sub {
my $uriobj = shift;
my $uri = shift;
if ($uri !~ /^http:/) {
return $uri;
}
# Do not shorten twice - heuristics!
if (length($uri) < 30) {
return $uri;
}
my $res = $heap->{'ua'}->get("http://tinyurl.com/api-create.php?url=$uri");
if ($res->is_success) {
return $res->content;
} else {
return $uri;
}
});
$finder->find(\$msg);
}
#Tweak the @replies
if ($msg =~ /^(\w+)\: / && $heap->{'config'}->{'convert_irc_replies'}) {
# @Olatho - changing ALL first-words that end with : to @, not only nicks on #Twitter
# - I sometimes reply to people that I do not follow, and want them converted as well
$msg =~ s/^(\w+)\: /\@$1 /;
}
#warn if asked and the message is too long after fucking with it
if ($heap->{'config'}->{'long_messages'} eq 'warn' && length($msg) > 140) {
$kernel->yield('server_reply',404,$target,'Your message is '.length($msg).' characters long. Your message was not sent.');
return;
}
#in a channel, this an update
my $update = eval { $heap->{'twitter'}->update($msg) };
my $error = $@;
if (!$update && ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to update status.',$error);
return;
}
$msg = $update->{'text'};
#update our own friend record
my $me = $kernel->call($_[SESSION],'getfriend',$heap->{'username'});
$me = $update->{'user'};
$me->{'status'} = $update;
$kernel->call($_[SESSION],'updatefriend',$me);
#keep the topic updated with our latest tweet
$kernel->yield('user_msg','TOPIC',$heap->{'username'},$target,"$heap->{'username'}'s last update: $msg");
# Olatho - Fixing duplicate topic-changes
$heap->{'channels'}->{$target}->{'topic'} = $msg;
$kernel->post('logger','log','Updated status.',$heap->{'username'});
} else {
#private message, it's a dm
my $dm = eval { $heap->{'twitter'}->new_direct_message({user => $target, text => $msg}) };
if (!$dm) {
$kernel->yield('server_reply',401,$target,"Unable to send direct message. Perhaps $target isn't following you?");
$kernel->post('logger','log',"Unable to send direct message to $target",$heap->{'username'});
} else {
$kernel->post('logger','log',"Sent direct message to $target",$heap->{'username'});
}
}
}
#allow the user to follow new users by adding them to the channel
sub irc_invite {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $target = $data->{'params'}[0];
my $chan = $data->{'params'}[1];
if (!$heap->{'channels'}->{$chan}->{'joined'}) {
$kernel->yield('server_reply',442,$chan,"You're not on that channel");
return;
}
if (exists $heap->{'channels'}->{$chan}->{'names'}->{$target}) {
$kernel->yield('server_reply',443,$target,$chan,'is already on channel');
return;
}
if ($chan ne '#twitter') { #if it's not our main channel, just fake the user in, if we already follow them
if (exists $heap->{'channels'}->{'#twitter'}->{'names'}->{$target}) {
$heap->{'channels'}->{$chan}->{'names'}->{$target} = $heap->{'channels'}->{'#twitter'}->{'names'}->{$target};
$kernel->yield('server_reply',341,$target,$chan);
$kernel->yield('user_msg','JOIN',$target,$chan);
if ($heap->{'channels'}->{$chan}->{'names'}->{$target} ne '') {
$kernel->yield('server_reply','MODE',$chan,'+v',$target);
}
} else {
$kernel->yield('server_reply',481,"You must invite the user to the #twitter channel first.");
}
return;
}
#if it's the main channel, we'll start following them on twitter
my $user = eval { $heap->{'twitter'}->create_friend({id => $target}) };
my $error = $@;
if ($user) {
if (!$user->{'protected'}) {
#if the user isn't protected, and we are following them now, then have 'em 'JOIN' the channel
push(@{$heap->{'friends'}},$user);
$kernel->yield('server_reply',341,$user->{'screen_name'},$chan);
$kernel->yield('user_msg','JOIN',$user->{'screen_name'},$chan);
$kernel->post('logger','log',"Started following $target",$heap->{'username'});
if ($kernel->call($_[SESSION],'getfollower',$user->{'screen_name'})) {
$heap->{'channels'}->{$chan}->{'names'}->{$target} = '+';
$kernel->yield('server_reply','MODE',$chan,'+v',$target);
} else {
$heap->{'channels'}->{$chan}->{'names'}->{$target} = '';
}
} else {
#show a note if they are protected and we are waiting
#this should technically be a 482, but some clients were exiting the channel for some reason
$kernel->yield('server_reply',481,"$target\'s updates are protected. Request to follow has been sent.");
$kernel->post('logger','log',"Sent request to follow $target",$heap->{'username'});
}
} else {
if (ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400 && $error->code() != 403) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to follow user.',$error);
} else {
$kernel->yield('server_reply',401,$target,'No such nick/channel');
$kernel->post('logger','log',"Attempted to follow non-existant user $target",$heap->{'username'});
}
}
}
#allow a user to unfollow/leave a user by kicking them from the channel
sub irc_kick {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $chan = $data->{'params'}[0];
my $target = $data->{'params'}[1];
if (!$heap->{'channels'}->{$chan}->{'joined'}) {
$kernel->yield('server_reply',442,$chan,"You're not on that channel");
return;
}
if (!exists $heap->{'channels'}->{$chan}->{'names'}->{$target}) {
$kernel->yield('server_reply',441,$target,$chan,"They aren't on that channel");
return;
}
if ($chan ne '#twitter') {
delete $heap->{'channels'}->{$chan}->{'names'}->{$target};
$kernel->yield('user_msg','KICK',$heap->{'username'},$chan,$target,$target);
return;
}
my $result = eval { $heap->{'twitter'}->destroy_friend($target) };
my $error = $@;
if ($result) {
$kernel->call($_[SESSION],'remfriend',$target);
delete $heap->{'channels'}->{$chan}->{'names'}->{$target};
$kernel->yield('user_msg','KICK',$heap->{'username'},$chan,$target,$target);
$kernel->post('logger','log',"Stoped following $target",$heap->{'username'});
} else {
if (ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to unfollow user.',$error);
} else {
$kernel->yield('server_reply',441,$target,$chan,"They aren't on that channel");
$kernel->post('logger','log',"Attempted to unfollow user ($target) we weren't following",$heap->{'username'});
}
}
}
sub irc_ping {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $target = $data->{'params'}[0];
$kernel->yield('server_reply','PONG','tircd',$target);
}
sub irc_away {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
if ($data->{'params'}[0]) {
$kernel->yield('server_reply',306,'You have been marked as being away');
} else {
$kernel->yield('server_reply',305,'You are no longer marked as being away');
}
}
sub irc_topic {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
my $chan = $data->{'params'}[0];
my $topic = $data->{'params'}[1];
return if $chan eq '#twitter';
if (!$heap->{'channels'}->{$chan}->{'joined'}) {
$kernel->yield('server_reply',442,$chan,"You're not on that channel");
return;
}
$heap->{'channels'}->{$chan}->{'topic'} = $topic;
$heap->{'channels'}->{$chan}->{'search_since_id'} = 0;
$kernel->yield('user_msg','TOPIC',$heap->{'username'},$chan,$topic);
$kernel->yield('twitter_search',$chan);
}
#shutdown the socket when the user quits
sub irc_quit {
my ($kernel, $heap, $data) = @_[KERNEL, HEAP, ARG0];
$kernel->yield('shutdown');
}
########### IRC 'SPECIAL CHANNELS'
sub channel_twitter {
my ($kernel,$heap,$chan) = @_[KERNEL, HEAP, ARG0];
#add our channel to the list
$heap->{'channels'}->{$chan} = {};
$heap->{'channels'}->{$chan}->{'joined'} = 1;
#get list of friends
my @friends = ();
my $cursor = -1;
my $error;
while (my $f = eval { $heap->{'twitter'}->friends({'cursor' => $cursor})}) {
$cursor = $f->{'next_cursor'};
foreach my $user ($f->{'users'}) {
foreach my $u (@{$user}) {
push(@friends, $u);
}
}
last if $cursor == 0;
}
my $error = $@;
#if we have no data, there was an error, or the user is a loser with no friends, eject 'em
if ($cursor == -1 && ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to get friends list.',$error);
return;
}
#get list of followers
my @followers = ();
$cursor = -1;
while (my $f = eval { $heap->{'twitter'}->followers({'cursor' => $cursor}) }) {
$cursor = $f->{'next_cursor'};
foreach my $user ($f->{'users'}) {
foreach my $u (@{$user}) {
push(@followers, $u);
}
}
last if $cursor == 0;
}
$error = $@;
#alert this error, but don't end 'em
if ($cursor == -1 && ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to get followers list.',$error);
}
#cache our friends and followers
$heap->{'friends'} = \@friends;
$heap->{'followers'} = \@followers;
$kernel->post('logger','log','Received friends list from Twitter, caching '.@{$heap->{'friends'}}.' friends.',$heap->{'username'});
$kernel->post('logger','log','Received followers list from Twitter, caching '.@{$heap->{'followers'}}.' followers.',$heap->{'username'});
#spoof the channel join
$kernel->yield('user_msg','JOIN',$heap->{'username'},$chan);
$kernel->yield('server_reply',332,$chan,"$heap->{'username'}'s twitter");
$kernel->yield('server_reply',333,$chan,'tircd!tircd@tircd',time());
#the the list of our users for /NAMES
my $lastmsg = '';
foreach my $user (@{$heap->{'friends'}}) {
my $ov ='';
if ($user->{'screen_name'} eq $heap->{'username'}) {
$lastmsg = $user->{'status'}->{'text'};
$ov = '@';
} elsif ($kernel->call($_[SESSION],'getfollower',$user->{'screen_name'})) {
$ov='+';
}
#keep a copy of who is in this channel
$heap->{'channels'}->{$chan}->{'names'}->{$user->{'screen_name'}} = $ov;
}
if (!$lastmsg) { #if we aren't already in the list, add us to the list for NAMES - AND go grab one tweet to put us in the array
$heap->{'channels'}->{$chan}->{'names'}->{$heap->{'username'}} = '@';
my $data = eval { $heap->{'twitter'}->user_timeline({count => 1}) };
if ($data && @$data > 0) {
$kernel->post('logger','log','Received user timeline from Twitter.',$heap->{'username'});
my $tmp = $$data[0]->{'user'};
$tmp->{'status'} = $$data[0];
$lastmsg = $tmp->{'status'}->{'text'};
push(@{$heap->{'friends'}},$tmp);
}
}
#send the /NAMES info
my $all_users = '';
foreach my $name (keys %{$heap->{'channels'}->{$chan}->{'names'}}) {
$all_users .= $heap->{'channels'}->{$chan}->{'names'}->{$name} . $name .' ';
}
$kernel->yield('server_reply',353,'=',$chan,$all_users);
$kernel->yield('server_reply',366,$chan,'End of /NAMES list');
$kernel->yield('user_msg','TOPIC',$heap->{'username'},$chan,"$heap->{'username'}'s last update: $lastmsg");
#start our twitter even loop, grab the timeline, replies and direct messages
$kernel->yield('twitter_timeline',$heap->{'config'}->{'join_silent'});
$kernel->yield('twitter_direct_messages',$heap->{'config'}->{'join_silent'});
return 1;
}
########### TWITTER EVENT/ALARM FUNCTIONS
sub twitter_timeline {
my ($kernel, $heap, $silent) = @_[KERNEL, HEAP, ARG0];
#get updated messages
my $timeline;
my $error;
if ($heap->{'timeline_since_id'}) {
$timeline = eval { $heap->{'twitter'}->home_timeline({count => $heap->{'config'}->{'timeline_count'}, since_id => $heap->{'timeline_since_id'}}) };
$error = $@;
} else {
$timeline = eval { $heap->{'twitter'}->home_timeline({count => $heap->{'config'}->{'timeline_count'}}) };
$error = $@;
}
#sometimes the twitter API returns undef, so we gotta check here
if (!$timeline || @$timeline == 0 || @{$timeline}[0]->{'id'} < $heap->{'timeline_since_id'} ) {
$timeline = [];
if (ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to update timeline.',$error);
}
} else {
#if we got new data save our position
$heap->{'timeline_since_id'} = @{$timeline}[0]->{'id'};
$kernel->post('logger','log','Received '.@$timeline.' timeline updates from Twitter.',$heap->{'username'});
}
#get updated @replies too
my $replies;
if ($heap->{'replies_since_id'}) {
$replies = eval { $heap->{'twitter'}->replies({since_id => $heap->{'replies_since_id'}}) };
$error = $@;
} else {
$replies = eval { $heap->{'twitter'}->replies({page =>1}) }; #avoid a bug in Net::Twitter
$error = $@;
}
if (!$replies || @$replies == 0) {
$replies = [];
if (ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to update @replies.',$error);
}
} else {
$heap->{'replies_since_id'} = @{$replies}[0]->{'id'};
$kernel->post('logger','log','Received '.@$replies.' @replies from Twitter.',$heap->{'username'});
}
#weave the two arrays together into one stream, removing duplicates
my @tmpdata = (@{$timeline},@{$replies});
my %tmphash = ();
foreach my $item (@tmpdata) {
$tmphash{$item->{'id'}} = $item;
}
#loop through each message
foreach my $item (sort {$a->{'id'} <=> $b->{'id'}} values %tmphash) {
my $tmp = $item->{'user'};
my $is_following = ();
$tmp->{'status'} = $item;
if (my $friend = $kernel->call($_[SESSION],'getfriend',$item->{'user'}->{'screen_name'})) { #if we've seen 'em before just update our cache
$kernel->call($_[SESSION],'updatefriend',$tmp);
} else {
# removed the fake join tempoarily while, I figure out the better way to handle this. I think the best is to leave it like this and treat the channels as if they are -n
# Olatho - Re enabled this - fixes the bug where you do not see tweets from people you add from other clients.
# But there is a problem here.
# If you are not following the user, and they mention you, they are joining the channel, and you can't /invite later..
# Adding a fake part again imediately if they are not a friend, to make it clear what happens
# Also, only adding them to 'friends' if they really are friends
$kernel->post('logger','log','Getting userinfo for ' . $item->{'user'}->{'screen_name'},$heap->{'username'});
$is_following = eval { $heap->{'twitter'}->show_user($item->{'user'}->{'screen_name'}) };
$kernel->post('logger','log','Got name: ' . $is_following->{'name'} . ' following: ' . $is_following->{'following'}, $heap->{'username'});
if ($is_following->{'following'} == 1) {
# We are following this user, add to 'friends'
push(@{$heap->{'friends'}},$tmp);
}
# Join them to #twitter
$kernel->yield('user_msg','JOIN',$item->{'user'}->{'screen_name'},'#twitter');
# Check if they should have voice (+v)
if ($kernel->call($_[SESSION],'getfollower',$item->{'user'}->{'screen_name'})) {
$heap->{'channels'}->{'#twitter'}->{'names'}->{$item->{'user'}->{'screen_name'}} = '+';
$kernel->yield('server_reply','MODE','#twitter','+v',$item->{'user'}->{'screen_name'});
} else {
$heap->{'channels'}->{'#twitter'}->{'names'}->{$item->{'user'}->{'screen_name'}} = '';
}
}
# filter out our own messages / don't display if not in silent mode
# Olatho - Don't understand what the original code tried to do, but my changes tries to do the right thing
# This will lead to seeing messages twice if you are tweeting actively, as messages are parsed both when you tweet, and when tircd receives the updates
# But I prefer that instead of missing messages I add from other clients
# This can be fixed by using a global buffer/cache to filter out the messages, not just the latest topic
if (($item->{'user'}->{'screen_name'} ne lc($heap->{'username'}) || !$heap->{'config'}->{'filter_self'})) {
if (!$silent) {
foreach my $chan (keys %{$heap->{'channels'}}) {
# - Send the message to the #twitter-channel if it is different from my latest update (IE different from current topic)
if ($chan eq '#twitter' && exists $heap->{'channels'}->{$chan}->{'names'}->{$item->{'user'}->{'screen_name'}} && $item->{'text'} ne $heap->{'channels'}->{$chan}->{'topic'}) {
$kernel->yield('user_msg','PRIVMSG',$item->{'user'}->{'screen_name'},$chan,$item->{'text'});
}
# - Send the message to the other channels the user is in if the user is not "me"
if ($chan ne '#twitter' && exists $heap->{'channels'}->{$chan}->{'names'}->{$item->{'user'}->{'screen_name'}} && $item->{'user'}->{'screen_name'} ne $heap->{'username'}) {
$kernel->yield('user_msg','PRIVMSG',$item->{'user'}->{'screen_name'},$chan,$item->{'text'});
}
# - And set topic on the #twitter channel if user is me and the topic is not already set
if ($chan eq '#twitter' && $item->{'user'}->{'screen_name'} eq $heap->{'username'} && $item->{'text'} ne $heap->{'channels'}->{$chan}->{'topic'}) {
$kernel->yield('user_msg','TOPIC',$heap->{'username'},$chan,"$heap->{'username'}'s last update: ".$item->{'text'});
$heap->{'channels'}->{$chan}->{'topic'} = $item->{'text'};
}
}
}
}
if (($is_following->{'status'}) && ($is_following->{'following'} == 0)) {
# If we are not following them - have them part #twitter again
$kernel->yield('user_msg','PART',$item->{'user'}->{'screen_name'},'#twitter');
delete $heap->{'channels'}->{'#twitter'}->{'names'}->{$item->{'user'}->{'screen_name'}};
}
}
$kernel->delay('twitter_timeline',$heap->{'config'}->{'update_timeline'});
}
#same as above, but for direct messages, show 'em as PRIVMSGs from the user
sub twitter_direct_messages {
my ($kernel, $heap, $silent) = @_[KERNEL, HEAP, ARG0];
my $data;
my $error;
if ($heap->{'direct_since_id'}) {
$data = eval { $heap->{'twitter'}->direct_messages({since_id => $heap->{'direct_since_id'}}) };
$error = $@;
} else {
$data = eval { $heap->{'twitter'}->direct_messages() };
$error = $@;
}
if (!$data || @$data == 0 || @{$data}[0]->{'id'} < $heap->{'direct_since_id'}) {
$data = [];
if (ref $error && $error->isa("Net::Twitter::Lite::Error") && $error->code() >= 400) {
$kernel->call($_[SESSION],'twitter_api_error','Unable to update direct messages.',$error);
}
} else {
$heap->{'direct_since_id'} = @{$data}[0]->{'id'};
$kernel->post('logger','log','Received '.@$data.' direct messages from Twitter.',$heap->{'username'});
}
foreach my $item (sort {$a->{'id'} <=> $b->{'id'}} @{$data}) {
if (!$kernel->call($_[SESSION],'getfriend',$item->{'sender'}->{'screen_name'})) {
my $tmp = $item->{'sender'};
$tmp->{'status'} = $item;
$tmp->{'status'}->{'text'} = '(dm) '.$tmp->{'status'}->{'text'};
push(@{$heap->{'friends'}},$tmp);
$kernel->yield('user_msg','JOIN',$item->{'sender'}->{'screen_name'},'#twitter');
if ($kernel->call($_[SESSION],'getfollower',$item->{'user'}->{'screen_name'})) {
$heap->{'channels'}->{'#twitter'}->{'names'}->{$item->{'user'}->{'screen_name'}} = '+';
$kernel->yield('server_reply','MODE','#twiter','+v',$item->{'user'}->{'screen_name'});
} else {
$heap->{'channels'}->{'#twitter'}->{'names'}->{$item->{'user'}->{'screen_name'}} = '';
}
}
if (!$silent) {
$kernel->yield('user_msg','PRIVMSG',$item->{'sender'}->{'screen_name'},$heap->{'username'},$item->{'text'});
}
}
$kernel->delay('twitter_direct_messages',$heap->{'config'}->{'update_directs'});
}
sub twitter_search {
my ($kernel, $heap, $chan) = @_[KERNEL, HEAP, ARG0];
if (!$heap->{'channels'}->{$chan}->{'joined'} || !$heap->{'channels'}->{$chan}->{'topic'}) {
#if we aren't in the channel, don't od anythning, this will keep us from restarting timers for channels we are no longer in
return;
}
my $data;
my $error;
if ($heap->{'channels'}->{$chan}->{'search_since_id'}) {
$data = eval {$heap->{'twitter'}->search({q => $heap->{'channels'}->{$chan}->{'topic'}, rpp => 100, since_id => $heap->{'channels'}->{$chan}->{'search_since_id'}});};
$error = $@;
} else {
$data = eval {$heap->{'twitter'}->search({q => $heap->{'channels'}->{$chan}->{'topic'}, rpp => 100});};
$error = $@;
}
if (!$data || $data->{'max_id'} < $heap->{'channels'}->{$chan}->{'search_since_id'} ) {
$data = {results => []};
$kernel->call($_[SESSION],'twitter_api_error','Unable to update search results.',$error);
} else {
$heap->{'channels'}->{$chan}->{'search_since_id'} = $data->{'max_id'};
if (@{$data->{'results'}} > 0) {
$kernel->post('logger','log','Received '.@{$data->{'results'}}.' search results from Twitter.',$heap->{'username'});
}
}
foreach my $result (sort {$a->{'id'} <=> $b->{'id'}} @{$data->{'results'}}) {
if ($result->{'from_user'} ne $heap->{'username'}) {
$kernel->yield('user_msg','PRIVMSG',$result->{'from_user'},$chan,$result->{'text'});
}
}
$kernel->delay_add('twitter_search',30,$chan);
}
__END__
=head1 Documentation moved
Please see tircd.pod which should have been included with this script
|