Add the Search role, so that subscriptions will work again
[twirssi-net-twitter-lite.git] / twirssi.pl
index ee06ff6d7fe2c5f57a610b4d9d103323a42d7e12..c133378cf92f23aeefcd8aac4f9f72e9c292c8a6 100644 (file)
@@ -7,11 +7,13 @@ use File::Temp;
 use LWP::Simple;
 use Data::Dumper;
 use Encode;
+use POSIX qw/:sys_wait_h/;
+use Net::Twitter qw/3.05/;
 $Data::Dumper::Indent = 1;
 
 use vars qw($VERSION %IRSSI);
 
-$VERSION = "2.3.4beta";
+$VERSION = "2.4.1beta";
 %IRSSI   = (
     authors     => 'Dan Boger',
     contact     => 'zigdon@gmail.com',
@@ -20,12 +22,13 @@ $VERSION = "2.3.4beta";
       . 'Can optionally set your bitlbee /away message to same',
     license => 'GNU GPL v2',
     url     => 'http://twirssi.com',
-    changed => '$Date: 2009-08-07 01:24:53 -0700 (Fri, 07 Aug 2009) $',
+    changed => 'Fri Jan 22 14:40:48 PST 2010',
 );
 
 my $window;
 my $twit;
 my %twits;
+my %oauth;
 my $user;
 my $defservice;
 my $poll;
@@ -428,7 +431,7 @@ sub cmd_logout {
     return unless $data = &valid_username($data);
 
     &notice("Logging out $data...");
-    $twits{$data}->end_session();
+    eval { $twits{$data}->end_session(); };
     delete $twits{$data};
     undef $twit;
     if ( keys %twits ) {
@@ -442,15 +445,26 @@ sub cmd_logout {
 sub cmd_login {
     my ( $data, $server, $win ) = @_;
     my $pass;
+    print "logging in: $data" if &debug;
     if ($data) {
+        print "manual data login" if &debug;
         ( $user, $pass ) = split ' ', $data, 2;
-        unless ($pass) {
+        unless ( Irssi::settings_get_bool("twirssi_use_oauth") or $pass ) {
             &notice("usage: /twitter_login <username>[\@<service>] <password>");
             return;
         }
+    } elsif ( Irssi::settings_get_bool("twirssi_use_oauth")
+        and my $autouser = Irssi::settings_get_str("twitter_usernames") )
+    {
+        print "oauth autouser login" if &debug;
+        foreach my $user ( split /,/, $autouser ) {
+            &cmd_login($user);
+        }
+        return;
     } elsif ( my $autouser = Irssi::settings_get_str("twitter_usernames")
         and my $autopass = Irssi::settings_get_str("twitter_passwords") )
     {
+        print "autouser login" if &debug;
         my @user = split /\s*,\s*/, $autouser;
         my @pass = split /\s*,\s*/, $autopass;
 
@@ -478,8 +492,10 @@ sub cmd_login {
             return;
         }
     } else {
-        &notice("/twitter_login requires either a username and password "
-              . "or twitter_usernames and twitter_passwords to be set." );
+        &notice("/twitter_login requires either a username/password "
+              . "or twitter_usernames and twitter_passwords to be set. "
+              . "Note that if twirssi_use_oauth is true, passwords are "
+              . "not required" );
         return;
     }
 
@@ -493,25 +509,151 @@ sub cmd_login {
     }
     $defservice = $service = ucfirst lc $service;
 
-    eval "use Net::$service 3.05";
-    if ($@) {
-        &notice(
-            "Failed to load Net::$service when trying to log in as $user: $@");
+    if ( $service eq 'Twitter'
+        and Irssi::settings_get_bool("twirssi_use_oauth") )
+    {
+        print "Attempting OAuth for $user\@$service" if &debug;
+        eval {
+            if ( $service eq 'Identica' )
+            {
+                $twit = Net::Twitter->new(
+                    identica => 1,
+                    traits   => [ 'API::REST', 'API::Search' ],
+                    source   => "twirssi",
+                    ssl      => !Irssi::settings_get_bool("twirssi_avoid_ssl"),
+                );
+            } else {
+                $twit = Net::Twitter->new(
+                    traits       => [ 'API::REST', 'OAuth', 'API::Search' ],
+                    consumer_key => 'BZVAvBma4GxdiRwXIvbnw',
+                    consumer_secret =>
+                      '0T5kahwLyb34vciGZsgkA9lsjtGCQ05vxVE2APXM',
+                    source => "twirssi",
+                    ssl    => !Irssi::settings_get_bool("twirssi_avoid_ssl"),
+                );
+            }
+        };
+
+        if ($twit) {
+            if ( open( OAUTH, Irssi::settings_get_str("twirssi_oauth_store") ) )
+            {
+                while (<OAUTH>) {
+                    chomp;
+                    next unless m/$user\@$service (\S+) (\S+)/i;
+                    print "Trying cached oauth creds for $user\@$service"
+                      if &debug;
+                    $twit->access_token($1);
+                    $twit->access_token_secret($2);
+                    last;
+                }
+                close OAUTH;
+            }
+
+            unless ( $twit->authorized ) {
+                my $url;
+                eval { $url = $twit->get_authorization_url; };
+
+                if ($@) {
+                    &notice(
+"ERROR: Failed to get OAuth authorization_url.  Try again later."
+                    );
+                    return;
+                }
+
+                &notice("Twirssi not autorized to access $service for $user.");
+                &notice(
+                    "Please authorize at the following url, then enter the pin "
+                );
+                &notice("supplied with /twirssi_oauth $user\@$service <pin>");
+                &notice($url);
+
+                $oauth{pending}{"$user\@$service"} = $twit;
+                return;
+            }
+        }
+    } else {
+        $twit = Net::Twitter->new(
+            $service eq 'Identica' ? ( identica => 1 ) : (),
+            username => $user,
+            password => $pass,
+            source   => "twirssi",
+            ssl      => Irssi::settings_get_bool("twirssi_avoid_ssl") ? 0 : 1,
+        );
+    }
+
+    unless ($twit) {
+        &notice("Failed to create object!  Aborting.");
         return;
     }
 
-    $twit = "Net::$service"->new(
-        username => $user,
-        password => $pass,
-        source   => "twirssi",
-        ssl      => Irssi::settings_get_bool("twirssi_avoid_ssl") ? 0 : 1,
-    );
+    return &verify_twitter_object( $server, $win, $user, $service, $twit );
+}
 
-    unless ($twit) {
-        &notice("Failed to create Net::$service object!  Aborting.");
+sub cmd_oauth {
+    my ( $data, $server, $win ) = @_;
+    my ( $key, $pin ) = split ' ', $data;
+    my ( $user, $service );
+    $key = &normalize_username($key);
+    if ( $key =~ /^(.*)@(Twitter|Identica)$/ ) {
+        ( $user, $service ) = ( $1, $2 );
+    }
+    $pin =~ s/\D//g;
+    print "Applying pin to $key" if &debug;
+
+    unless ( exists $oauth{pending}{$key} ) {
+        &notice("There isn't a pending oauth request for $key. "
+              . "Try /twitter_login first" );
+        return;
+    }
+
+    my $twit = $oauth{pending}{$key};
+    my ( $access_token, $access_token_secret );
+    eval {
+        ( $access_token, $access_token_secret ) =
+          $twit->request_access_token( verifier => $pin );
+    };
+
+    if ($@) {
+        &notice("Invalid pin, try again.");
         return;
     }
 
+    delete $oauth{pending}{$key};
+
+    my $store_file = Irssi::settings_get_str("twirssi_oauth_store");
+    if ($store_file) {
+        my @store;
+        if ( open( OAUTH, $store_file ) ) {
+            while (<OAUTH>) {
+                chomp;
+                next if /$key/i;
+                push @store, $_;
+            }
+            close OAUTH;
+
+        }
+
+        push @store, "$key $access_token $access_token_secret";
+
+        if ( open( OAUTH, ">$store_file.new" ) ) {
+            print OAUTH "$_\n" foreach @store;
+            close OAUTH;
+            rename "$store_file.new", $store_file
+              or &notice("Failed to rename $store_file.new: $!");
+        } else {
+            &notice("Failed to write $store_file.new: $!");
+        }
+    } else {
+        &notice("No persistant storage set for OAuth.  "
+              . "Please /set twirssi_oauth_store to a writable filename." );
+    }
+
+    return &verify_twitter_object( $server, $win, $user, $service, $twit );
+}
+
+sub verify_twitter_object {
+    my ( $server, $win, $user, $service, $twit ) = @_;
+
     if ( my $timeout = Irssi::settings_get_int("twitter_timeout")
         and $twit->can('ua') )
     {
@@ -537,31 +679,27 @@ sub cmd_login {
         return;
     }
 
-    if ($twit) {
-        my $rate_limit = $twit->rate_limit_status();
-        if ( $rate_limit and $rate_limit->{remaining_hits} < 1 ) {
-            &notice(
-                "Rate limit exceeded, try again after $rate_limit->{reset_time}"
-            );
-            $twit = undef;
-            return;
-        }
+    my $rate_limit = $twit->rate_limit_status();
+    if ( $rate_limit and $rate_limit->{remaining_hits} < 1 ) {
+        &notice(
+            "Rate limit exceeded, try again after $rate_limit->{reset_time}");
+        $twit = undef;
+        return;
+    }
 
-        $twits{"$user\@$service"} = $twit;
-        Irssi::timeout_remove($poll) if $poll;
-        $poll = Irssi::timeout_add( &get_poll_time * 1000, \&get_updates, "" );
-        &notice("Logged in as $user\@$service, loading friends list...");
-        &load_friends();
-        &notice( "loaded friends: ", scalar keys %friends );
-        if ( Irssi::settings_get_bool("twirssi_first_run") ) {
-            Irssi::settings_set_bool( "twirssi_first_run", 0 );
-        }
-        %nicks = %friends;
-        $nicks{$user} = 0;
-        return 1;
-    } else {
-        &notice("Login failed");
+    print "saving object for $user\@$service" if &debug;
+    $twits{"$user\@$service"} = $twit;
+    Irssi::timeout_remove($poll) if $poll;
+    $poll = Irssi::timeout_add( &get_poll_time * 1000, \&get_updates, "" );
+    &notice("Logged in as $user\@$service, loading friends list...");
+    &load_friends();
+    &notice( "loaded friends: ", scalar keys %friends );
+    if ( Irssi::settings_get_bool("twirssi_first_run") ) {
+        Irssi::settings_set_bool( "twirssi_first_run", 0 );
     }
+    %nicks = %friends;
+    $nicks{$user} = 0;
+    return 1;
 }
 
 sub cmd_add_follow {
@@ -927,11 +1065,13 @@ sub get_updates {
 sub do_updates {
     my ( $fh, $username, $obj, $cache ) = @_;
 
-    my $rate_limit = $obj->rate_limit_status();
-    if ( $rate_limit and $rate_limit->{remaining_hits} < 1 ) {
-        &notice("Rate limit exceeded for $username");
-        return undef;
-    }
+    eval {
+        my $rate_limit = $obj->rate_limit_status();
+        if ( $rate_limit and $rate_limit->{remaining_hits} < 1 ) {
+            &notice("Rate limit exceeded for $username");
+            return undef;
+        }
+    };
 
     print scalar localtime, " - Polling for updates for $username" if &debug;
     my $tweets;
@@ -968,9 +1108,7 @@ sub do_updates {
     }
 
     foreach my $t ( reverse @$tweets ) {
-        my $text =
-          decode_entities( $t->{retweeted_status}{text} || $t->{text} );
-        $text =~ s/[\n\r]/ /g;
+        my $text = &get_text( $t, $obj );
         my $reply = "tweet";
         if (    Irssi::settings_get_bool("show_reply_context")
             and $t->{in_reply_to_screen_name} ne $username
@@ -989,15 +1127,7 @@ sub do_updates {
             $context = $cache->{ $t->{in_reply_to_status_id} };
 
             if ($context) {
-                my $ctext =
-                  decode_entities( $context->{retweeted_status}{text}
-                      || $context->{text} );
-                $ctext =~ s/[\n\r]/ /g;
-                if ( $context->{truncated} and ref($obj) ne 'Net::Identica' ) {
-                    $ctext .=
-                        " -- http://twitter.com/$context->{user}{screen_name}"
-                      . "/status/$context->{id}";
-                }
+                my $ctext = &get_text( $context, $obj );
                 printf $fh "id:%s account:%s nick:%s type:tweet %s\n",
                   $context->{id}, $username,
                   $context->{user}{screen_name}, $ctext;
@@ -1007,10 +1137,6 @@ sub do_updates {
         next
           if $t->{user}{screen_name} eq $username
               and not Irssi::settings_get_bool("show_own_tweets");
-        if ( $t->{truncated} and ref($obj) ne 'Net::Identica' ) {
-            $text .= " -- http://twitter.com/$t->{user}{screen_name}"
-              . "/status/$t->{id}";
-        }
         printf $fh "id:%s account:%s nick:%s type:%s %s\n",
           $t->{id}, $username, $t->{user}{screen_name}, $reply, $text;
         $new_poll_id = $t->{id} if $new_poll_id < $t->{id};
@@ -1042,13 +1168,7 @@ sub do_updates {
         next
           if exists $friends{ $t->{user}{screen_name} };
 
-        my $text =
-          decode_entities( $t->{retweeted_status}{text} || $t->{text} );
-        $text =~ s/[\n\r]/ /g;
-        if ( $t->{truncated} ) {
-            $text .= " -- http://twitter.com/$t->{user}{screen_name}"
-              . "/status/$t->{id}";
-        }
+        my $text = &get_text( $t, $obj );
         printf $fh "id:%s account:%s nick:%s type:tweet %s\n",
           $t->{id}, $username, $t->{user}{screen_name}, $text;
         $new_poll_id = $t->{id} if $new_poll_id < $t->{id};
@@ -1114,9 +1234,7 @@ sub do_updates {
               $search->{max_id}, $username, $topic;
 
             foreach my $t ( reverse @{ $search->{results} } ) {
-                my $text =
-                  decode_entities( $t->{retweeted_status}{text} || $t->{text} );
-                $text =~ s/[\n\r]/ /g;
+                my $text = &get_text( $t, $obj );
                 printf $fh "id:%s account:%s nick:%s type:search topic:%s %s\n",
                   $t->{id}, $username, $t->{from_user}, $topic, $text;
                 $new_poll_id = $t->{id}
@@ -1162,9 +1280,7 @@ sub get_timeline {
     }
 
     foreach my $t ( reverse @$tweets ) {
-        my $text =
-          decode_entities( $t->{retweeted_status}{text} || $t->{text} );
-        $text =~ s/[\n\r]/ /g;
+        my $text = &get_text( $t, $obj );
         my $reply = "tweet";
         if (    Irssi::settings_get_bool("show_reply_context")
             and $t->{in_reply_to_screen_name} ne $username
@@ -1183,25 +1299,13 @@ sub get_timeline {
             $context = $cache->{ $t->{in_reply_to_status_id} };
 
             if ($context) {
-                my $ctext =
-                  decode_entities( $context->{retweeted_status}{text}
-                      || $context->{text} );
-                $ctext =~ s/[\n\r]/ /g;
-                if ( $context->{truncated} and ref($obj) ne 'Net::Identica' ) {
-                    $ctext .=
-                        " -- http://twitter.com/$context->{user}{screen_name}"
-                      . "/status/$context->{id}";
-                }
+                my $ctext = &get_text( $context, $obj );
                 printf $fh "id:%s account:%s nick:%s type:tweet %s\n",
                   $context->{id}, $username,
                   $context->{user}{screen_name}, $ctext;
                 $reply = "reply";
             }
         }
-        if ( $t->{truncated} and ref($obj) ne 'Net::Identica' ) {
-            $text .= " -- http://twitter.com/$t->{user}{screen_name}"
-              . "/status/$t->{id}";
-        }
         printf $fh "id:%s account:%s nick:%s type:%s %s\n",
           $t->{id}, $username, $t->{user}{screen_name}, $reply, $text;
         $last_id = $t->{id} if $last_id < $t->{id};
@@ -1221,6 +1325,9 @@ sub monitor_child {
       if &debug;
     my ($new_last_poll);
 
+    # reap any random leftover processes - work around a bug in irssi on gentoo
+    waitpid( -1, WNOHANG );
+
     # first time we run we don't want to print out *everything*, so we just
     # pretend
 
@@ -1694,6 +1801,25 @@ sub normalize_username {
     return "$username\@$service";
 }
 
+sub get_text {
+    my $tweet  = shift;
+    my $object = shift;
+    my $text   = decode_entities( $tweet->{text} );
+    if ( $tweet->{truncated} ) {
+        if ( exists $tweet->{retweeted_status} ) {
+            $text = "RT \@$tweet->{retweeted_status}{user}{screen_name}: "
+              . "$tweet->{retweeted_status}{text}";
+        } elsif ( $object->isa('Net::Twitter') ) {
+            $text .= " -- http://twitter.com/$tweet->{user}{screen_name}"
+              . "/status/$tweet->{id}";
+        }
+    }
+
+    $text =~ s/[\n\r]/ /g;
+
+    return $text;
+}
+
 Irssi::signal_add( "send text", "event_send_text" );
 
 Irssi::theme_register(
@@ -1719,9 +1845,11 @@ Irssi::settings_add_str( "twirssi", "twirssi_topic_color",     "%r" );
 Irssi::settings_add_str( "twirssi", "twirssi_retweet_format",
     'RT $n: "$t" ${-- $c$}' );
 Irssi::settings_add_str( "twirssi", "twirssi_location",
-    ".irssi/scripts/twirssi.pl" );
+    "$ENV{HOME}/.irssi/scripts/twirssi.pl" );
 Irssi::settings_add_str( "twirssi", "twirssi_replies_store",
-    ".irssi/scripts/twirssi.json" );
+    "$ENV{HOME}/.irssi/scripts/twirssi.json" );
+Irssi::settings_add_str( "twirssi", "twirssi_oauth_store",
+    "$ENV{HOME}/.irssi/scripts/twirssi.oauth" );
 
 Irssi::settings_add_int( "twirssi", "twitter_friends_poll", 600 );
 Irssi::settings_add_int( "twirssi", "twitter_timeout",      30 );
@@ -1740,6 +1868,7 @@ Irssi::settings_add_bool( "twirssi", "twirssi_hilights",          1 );
 Irssi::settings_add_bool( "twirssi", "twirssi_always_shorten",    0 );
 Irssi::settings_add_bool( "twirssi", "tweet_window_input",        0 );
 Irssi::settings_add_bool( "twirssi", "twirssi_avoid_ssl",         0 );
+Irssi::settings_add_bool( "twirssi", "twirssi_use_oauth",         1 );
 
 $last_poll = time - &get_poll_time;
 $window = Irssi::window_find_name( Irssi::settings_get_str('twitter_window') );
@@ -1770,6 +1899,7 @@ if ($window) {
     Irssi::command_bind( "twitter_unsubscribe",        "cmd_del_search" );
     Irssi::command_bind( "twitter_list_subscriptions", "cmd_list_search" );
     Irssi::command_bind( "twirssi_upgrade",            "cmd_upgrade" );
+    Irssi::command_bind( "twirssi_oauth",              "cmd_oauth" );
     Irssi::command_bind( "twitter_updates",            "get_updates" );
     Irssi::command_bind( "twitter_add_follow_extra",   "cmd_add_follow" );
     Irssi::command_bind( "twitter_del_follow_extra",   "cmd_del_follow" );
@@ -1896,9 +2026,7 @@ if ($window) {
         }
     }
 
-    if (    my $autouser = Irssi::settings_get_str("twitter_usernames")
-        and my $autopass = Irssi::settings_get_str("twitter_passwords") )
-    {
+    if ( my $autouser = Irssi::settings_get_str("twitter_usernames") ) {
         &cmd_login();
         &get_updates;
     }