1.7.3 - r353 - Refactor a lot of the duplicated code into subs
[twirssi-net-twitter-lite.git] / twirssi.pl
index 8f7f966cd42fa7326cd4b5e4a664b092900208c9..46d2e2cce105e36f00063d1d3bdd9f7af73209e9 100644 (file)
@@ -1,7 +1,6 @@
 use strict;
 use Irssi;
 use Irssi::Irc;
-use Net::Twitter;
 use HTTP::Date;
 use HTML::Entities;
 use File::Temp;
@@ -9,10 +8,18 @@ use LWP::Simple;
 use Data::Dumper;
 $Data::Dumper::Indent = 1;
 
+BEGIN {
+    $ENV{JSON_ANY_ORDER} = "JSON Syck DWIW";
+    require JSON::Any;
+    import JSON::Any;
+    require Net::Twitter;
+    import Net::Twitter;
+}
+
 use vars qw($VERSION %IRSSI);
 
-$VERSION = "1.6.1";
-my ($REV) = '$Rev: 336 $' =~ /(\d+)/;
+$VERSION = "1.7.3";
+my ($REV) = '$Rev: 353 $' =~ /(\d+)/;
 %IRSSI = (
     authors     => 'Dan Boger',
     contact     => 'zigdon@gmail.com',
@@ -21,7 +28,7 @@ my ($REV) = '$Rev: 336 $' =~ /(\d+)/;
       . 'Can optionally set your bitlbee /away message to same',
     license => 'GNU GPL v2',
     url     => 'http://tinyurl.com/twirssi',
-    changed => 'Mon Dec  1 15:36:01 PST 2008',
+    changed => '$Date: 2009-01-08 14:17:30 -0800 (Thu, 08 Jan 2009) $',
 );
 
 my $window;
@@ -38,10 +45,7 @@ my %id_map;
 sub cmd_direct {
     my ( $data, $server, $win ) = @_;
 
-    unless ($twit) {
-        &notice("Not logged in!  Use /twitter_login username pass!");
-        return;
-    }
+    return unless &logged_in($twit);
 
     my ( $target, $text ) = split ' ', $data, 2;
     unless ( $target and $text ) {
@@ -55,10 +59,7 @@ sub cmd_direct {
 sub cmd_direct_as {
     my ( $data, $server, $win ) = @_;
 
-    unless ($twit) {
-        &notice("Not logged in!  Use /twitter_login username pass!");
-        return;
-    }
+    return unless &logged_in($twit);
 
     my ( $username, $target, $text ) = split ' ', $data, 3;
     unless ( $username and $target and $text ) {
@@ -66,10 +67,7 @@ sub cmd_direct_as {
         return;
     }
 
-    unless ( exists $twits{$username} ) {
-        &notice("Unknown username $username");
-        return;
-    }
+    return unless &valid_username($username);
 
     eval {
         unless ( $twits{$username}
@@ -92,10 +90,7 @@ sub cmd_direct_as {
 sub cmd_tweet {
     my ( $data, $server, $win ) = @_;
 
-    unless ($twit) {
-        &notice("Not logged in!  Use /twitter_login username pass!");
-        return;
-    }
+    return unless &logged_in($twit);
 
     $data =~ s/^\s+|\s+$//;
     unless ($data) {
@@ -109,10 +104,7 @@ sub cmd_tweet {
 sub cmd_tweet_as {
     my ( $data, $server, $win ) = @_;
 
-    unless ($twit) {
-        &notice("Not logged in!  Use /twitter_login username pass!");
-        return;
-    }
+    return unless &logged_in($twit);
 
     $data =~ s/^\s+|\s+$//;
     my ( $username, $data ) = split ' ', $data, 2;
@@ -122,10 +114,7 @@ sub cmd_tweet_as {
         return;
     }
 
-    unless ( exists $twits{$username} ) {
-        &notice("Unknown username $username");
-        return;
-    }
+    return unless &valid_username($username);
 
     if ( Irssi::settings_get_str("short_url_provider") ) {
         foreach my $url ( $data =~ /(https?:\/\/\S+[\w\/])/g ) {
@@ -136,11 +125,7 @@ sub cmd_tweet_as {
         }
     }
 
-    if ( length $data > 140 ) {
-        &notice(
-            "Tweet too long (" . length($data) . " characters) - aborted" );
-        return;
-    }
+    return if &too_long($data);
 
     eval {
         unless ( $twits{$username}->update($data) )
@@ -159,21 +144,7 @@ sub cmd_tweet_as {
         $nicks{$1} = time;
     }
 
-    my $away = 0;
-    if (    Irssi::settings_get_bool("tweet_to_away")
-        and $data !~ /\@\w/
-        and $data !~ /^[dD] / )
-    {
-        my $server =
-          Irssi::server_find_tag( Irssi::settings_get_str("bitlbee_server") );
-        if ($server) {
-            $server->send_raw("away :$data");
-            $away = 1;
-        } else {
-            &notice( "Can't find bitlbee server.",
-                "Update bitlbee_server or disalbe tweet_to_away" );
-        }
-    }
+    my $away = &update_away($data);
 
     &notice( "Update sent" . ( $away ? " (and away msg set)" : "" ) );
 }
@@ -181,10 +152,7 @@ sub cmd_tweet_as {
 sub cmd_reply {
     my ( $data, $server, $win ) = @_;
 
-    unless ($twit) {
-        &notice("Not logged in!  Use /twitter_login username pass!");
-        return;
-    }
+    return unless &logged_in($twit);
 
     $data =~ s/^\s+|\s+$//;
     unless ($data) {
@@ -212,10 +180,7 @@ sub cmd_reply_as {
         return;
     }
 
-    unless ($twit) {
-        &notice("Not logged in!  Use /twitter_login username pass!");
-        return;
-    }
+    return unless &logged_in($twit);
 
     $data =~ s/^\s+|\s+$//;
     my ( $username, $id, $data ) = split ' ', $data, 3;
@@ -225,15 +190,12 @@ sub cmd_reply_as {
         return;
     }
 
-    unless ( exists $twits{$username} ) {
-        &notice("Unknown username $username");
-        return;
-    }
+    return unless &valid_username($username);
 
     my $nick;
     $id =~ s/[^\w\d\-:]+//g;
     ( $nick, $id ) = split /:/, $id;
-    unless ( exists $id_map{$nick} ) {
+    unless ( exists $id_map{ lc $nick } ) {
         &notice("Can't find a tweet from $nick to reply to!");
         return;
     }
@@ -257,11 +219,7 @@ sub cmd_reply_as {
         }
     }
 
-    if ( length $data > 140 ) {
-        &notice(
-            "Tweet too long (" . length($data) . " characters) - aborted" );
-        return;
-    }
+    return if &too_long($data);
 
     eval {
         unless (
@@ -287,21 +245,7 @@ sub cmd_reply_as {
         $nicks{$1} = time;
     }
 
-    my $away = 0;
-    if (    Irssi::settings_get_bool("tweet_to_away")
-        and $data !~ /\@\w/
-        and $data !~ /^[dD] / )
-    {
-        my $server =
-          Irssi::server_find_tag( Irssi::settings_get_str("bitlbee_server") );
-        if ($server) {
-            $server->send_raw("away :$data");
-            $away = 1;
-        } else {
-            &notice( "Can't find bitlbee server.",
-                "Update bitlbee_server or disalbe tweet_to_away" );
-        }
-    }
+    my $away = &update_away($data);
 
     &notice( "Update sent" . ( $away ? " (and away msg set)" : "" ) );
 }
@@ -312,10 +256,7 @@ sub gen_cmd {
     return sub {
         my ( $data, $server, $win ) = @_;
 
-        unless ($twit) {
-            &notice("Not logged in!  Use /twitter_login username pass!");
-            return;
-        }
+        return unless &logged_in($twit);
 
         $data =~ s/^\s+|\s+$//;
         unless ($data) {
@@ -357,12 +298,12 @@ sub cmd_logout {
     my ( $data, $server, $win ) = @_;
 
     $data =~ s/^\s+|\s+$//g;
-    if ( $data and exists $twits{$data} ) {
+    return unless &valid_username($data);
+
+    if ($data) {
         &notice("Logging out $data...");
         $twits{$data}->end_session();
         delete $twits{$data};
-    } elsif ($data) {
-        &notice("Unknown username '$data'");
     } else {
         &notice("Logging out $user...");
         $twit->end_session();
@@ -553,7 +494,8 @@ sub load_friends {
     eval {
         while (1)
         {
-            print $fh "Loading friends page $page...\n" if ( $fh and &debug );
+            print $fh "type:debug Loading friends page $page...\n"
+              if ( $fh and &debug );
             my $friends = $twit->friends( { page => $page } );
             last unless $friends;
             $new_friends{ $_->{screen_name} } = time foreach @$friends;
@@ -563,19 +505,20 @@ sub load_friends {
     };
 
     if ($@) {
-        &notice("Error during friends list update.  Aborted.");
+        print $fh "type:debug Error during friends list update.  Aborted.\n";
         return;
     }
 
     my ( $added, $removed ) = ( 0, 0 );
-    print $fh "Scanning for new friends...\n" if ( $fh and &debug );
+    print $fh "type:debug Scanning for new friends...\n" if ( $fh and &debug );
     foreach ( keys %new_friends ) {
         next if exists $friends{$_};
         $friends{$_} = time;
         $added++;
     }
 
-    print $fh "Scanning for removed friends...\n" if ( $fh and &debug );
+    print $fh "type:debug Scanning for removed friends...\n"
+      if ( $fh and &debug );
     foreach ( keys %friends ) {
         next if exists $new_friends{$_};
         delete $friends{$_};
@@ -596,16 +539,14 @@ sub get_updates {
               . Irssi::settings_get_str('twitter_window')
               . "'.  Create it or change the value of twitter_window" );
     }
-    unless ($twit) {
-        &notice("Not logged in!  Use /twitter_login username pass!");
-        return;
-    }
+
+    return unless &logged_in($twit);
 
     my ( $fh, $filename ) = File::Temp::tempfile();
     my $pid = fork();
 
     if ($pid) {    # parent
-        Irssi::timeout_add_once( 5000, 'monitor_child', [$filename] );
+        Irssi::timeout_add_once( 5000, 'monitor_child', [ $filename, 0 ] );
         Irssi::pidwait_add($pid);
     } elsif ( defined $pid ) {    # child
         close STDIN;
@@ -614,15 +555,16 @@ sub get_updates {
 
         my $new_poll = time;
 
-        &do_updates( $fh, $user, $twit );
+        my $error = 0;
+        $error += &do_updates( $fh, $user, $twit );
         foreach ( keys %twits ) {
             next if $_ eq $user;
-            &do_updates( $fh, $_, $twits{$_} );
+            $error += &do_updates( $fh, $_, $twits{$_} );
         }
 
         my ( $added, $removed ) = &load_friends($fh);
         if ( $added + $removed ) {
-            print $fh "%R***%n Friends list updated: ",
+            print $fh "type:debug %R***%n Friends list updated: ",
               join( ", ",
                 sprintf( "%d added",   $added ),
                 sprintf( "%d removed", $removed ) ),
@@ -632,7 +574,13 @@ sub get_updates {
         foreach ( sort keys %friends ) {
             print $fh "$_ $friends{$_}\n";
         }
-        print $fh $new_poll;
+
+        if ($error) {
+            print $fh "type:debug Update encountered errors.  Aborted\n";
+            print $fh $last_poll;
+        } else {
+            print $fh $new_poll;
+        }
         close $fh;
         exit;
     }
@@ -646,13 +594,23 @@ sub do_updates {
     my $tweets;
     eval {
         $tweets = $obj->friends_timeline(
-            { since => HTTP::Date::time2str($last_poll) } )
-          || [];
+            { since => HTTP::Date::time2str($last_poll) } );
     };
 
     if ($@) {
-        printf $fh "type:error Error during friends_timeline call.  Aborted.\n"
-          return;
+        print $fh "type:debug Error during friends_timeline call.  Aborted.\n";
+        return 1;
+    }
+
+    unless ( ref $tweets ) {
+        if ( $obj->can("get_error") ) {
+            print $fh "type:debug API Error during friends_timeline call: ",
+              JSON::Any->jsonToObj( $obj->get_error() ), "  Aborted.\n";
+        } else {
+            print $fh
+              "type:debug API Error during friends_timeline call. Aborted.\n";
+        }
+        return 1;
     }
 
     foreach my $t ( reverse @$tweets ) {
@@ -666,7 +624,11 @@ sub do_updates {
             and not exists $friends{ $t->{in_reply_to_screen_name} } )
         {
             $nicks{ $t->{in_reply_to_screen_name} } = time;
-            my $context = $obj->show_status( $t->{in_reply_to_status_id} );
+            my $context;
+            eval {
+                $context = $obj->show_status( $t->{in_reply_to_status_id} );
+            };
+
             if ($context) {
                 my $ctext = decode_entities( $context->{text} );
                 $ctext =~ s/%/%%/g;
@@ -675,8 +637,11 @@ sub do_updates {
                   $context->{id}, $username,
                   $context->{user}{screen_name}, $ctext;
                 $reply = "reply";
+            } elsif ($@) {
+                print $fh "type:debug request to get context failed: $@";
             } else {
-                print "Failed to get context from $t->{in_reply_to_screen_name}"
+                print $fh
+"type:debug Failed to get context from $t->{in_reply_to_screen_name}"
                   if &debug;
             }
         }
@@ -691,10 +656,11 @@ sub do_updates {
     eval {
         $tweets = $obj->replies( { since => HTTP::Date::time2str($last_poll) } )
           || [];
-      }
+    };
 
-      if ($@) {
-        printf $fh "type:error Error during replies call.  Aborted.\n" return;
+    if ($@) {
+        print $fh "type:debug Error during replies call.  Aborted.\n";
+        return 1;
     }
 
     foreach my $t ( reverse @$tweets ) {
@@ -709,9 +675,17 @@ sub do_updates {
     }
 
     print scalar localtime, " - Polling for DMs" if &debug;
-    $tweets =
-      $obj->direct_messages( { since => HTTP::Date::time2str($last_poll) } )
-      || [];
+    eval {
+        $tweets =
+          $obj->direct_messages( { since => HTTP::Date::time2str($last_poll) } )
+          || [];
+    };
+
+    if ($@) {
+        print $fh "type:debug Error during direct_messages call.  Aborted.\n";
+        return 1;
+    }
+
     foreach my $t ( reverse @$tweets ) {
         my $text = decode_entities( $t->{text} );
         $text =~ s/%/%%/g;
@@ -720,14 +694,18 @@ sub do_updates {
           $t->{id}, $username, $t->{sender_screen_name}, $text;
     }
     print scalar localtime, " - Done" if &debug;
+
+    return 0;
 }
 
 sub monitor_child {
-    my $data     = shift;
+    my ($data)   = @_;
     my $filename = $data->[0];
+    my $attempt  = $data->[1];
 
-    print scalar localtime, " - checking child log at $filename" if &debug;
-    my $old_last_poll = $last_poll;
+    print scalar localtime, " - checking child log at $filename ($attempt)"
+      if &debug;
+    my $new_last_poll;
     if ( open FILE, $filename ) {
         my @lines;
         while (<FILE>) {
@@ -735,11 +713,12 @@ sub monitor_child {
             last if /^__friends__/;
             my %meta;
             foreach my $key (qw/id account nick type/) {
-                s/^$key:(\S+)\s*//;
-                $meta{$key} = $1;
+                if (s/^$key:(\S+)\s*//) {
+                    $meta{$key} = $1;
+                }
             }
 
-            next if exists $tweet_cache{ $meta{id} };
+            next if exists $meta{id} and exists $tweet_cache{ $meta{id} };
             $tweet_cache{ $meta{id} } = time;
             my $account = "";
             if ( $meta{account} ne $user ) {
@@ -763,26 +742,28 @@ sub monitor_child {
             } elsif ( $meta{type} eq 'reply' ) {
                 push @lines, "[$account\\--> %B\@$meta{nick}%n$marker] $_\n",;
             } elsif ( $meta{type} eq 'dm' ) {
-                push @lines, "[$account%B\@$meta{nick}%n (%%WDM%%n)] $_\n",;
+                push @lines, "[$account%B\@$meta{nick}%n (%WDM%n)] $_\n",;
             } elsif ( $meta{type} eq 'error' ) {
-                push @lines, "debug: $_\n" if &debug,;
+                push @lines, "ERROR: $_\n";
             } elsif ( $meta{type} eq 'debug' ) {
-                push @lines, "debug: $_\n" if &debug,;
+                print "$_" if &debug,;
+            } else {
+                print "Unknown line type $meta{type}: $_" if &debug,;
             }
         }
 
         %friends = ();
         while (<FILE>) {
             if (/^\d+$/) {
-                $last_poll = $_;
+                $new_last_poll = $_;
                 last;
             }
             my ( $f, $t ) = split ' ', $_;
             $nicks{$f} = $friends{$f} = $t;
         }
 
-        if ( $last_poll != $old_last_poll ) {
-            print "new last_poll = $last_poll" if &debug;
+        if ($new_last_poll) {
+            print "new last_poll = $new_last_poll" if &debug;
             foreach my $line (@lines) {
                 chomp $line;
                 $window->print( $line, MSGLEVEL_PUBLIC );
@@ -796,17 +777,38 @@ sub monitor_child {
               or warn "Failed to remove $filename: $!"
               unless &debug;
 
-      # keep 10 minutes of cached tweets, to make sure we don't show duplicates.
+            # keep enough cached tweets, to make sure we don't show duplicates.
             foreach ( keys %tweet_cache ) {
-                next if $tweet_cache{$_} > time - 600;
+                next if $tweet_cache{$_} >= $last_poll;
                 delete $tweet_cache{$_};
             }
+            $last_poll = $new_last_poll;
+
+            # save id_map hash
+            if ( keys %id_map
+                and my $file =
+                Irssi::settings_get_str("twirssi_replies_store") )
+            {
+                if ( open JSON, ">$file" ) {
+                    print JSON JSON::Any->objToJson( \%id_map );
+                    close JSON;
+                } else {
+                    &notice("Failed to write replies to $file: $!");
+                }
+            }
             return;
         }
     }
 
     close FILE;
-    Irssi::timeout_add_once( 5000, 'monitor_child', [$filename] );
+
+    if ( $attempt < 12 ) {
+        Irssi::timeout_add_once( 5000, 'monitor_child',
+            [ $filename, $attempt + 1 ] );
+    } else {
+        &notice("Giving up on polling $filename");
+        unlink $filename unless &debug;
+    }
 }
 
 sub debug {
@@ -817,6 +819,61 @@ sub notice {
     $window->print( "%R***%n @_", MSGLEVEL_PUBLIC );
 }
 
+sub update_away {
+    my $data = shift;
+
+    if (    Irssi::settings_get_bool("tweet_to_away")
+        and $data !~ /\@\w/
+        and $data !~ /^[dD] / )
+    {
+        my $server =
+          Irssi::server_find_tag( Irssi::settings_get_str("bitlbee_server") );
+        if ($server) {
+            $server->send_raw("away :$data");
+            return 1;
+        } else {
+            &notice( "Can't find bitlbee server.",
+                "Update bitlbee_server or disable tweet_to_away" );
+            return 0;
+        }
+    }
+
+    return 0;
+}
+
+sub too_long {
+    my $data = shift;
+
+    if ( length $data > 140 ) {
+        &notice(
+            "Tweet too long (" . length($data) . " characters) - aborted" );
+        return 1;
+    }
+
+    return 0;
+}
+
+sub valid_username {
+    my $username = shift;
+
+    unless ( exists $twits{$username} ) {
+        &notice("Unknown username $username");
+        return 0;
+    }
+
+    return 1;
+}
+
+sub logged_in {
+    my $obj = shift;
+    unless ($obj) {
+        &notice("Not logged in!  Use /twitter_login username pass!");
+        return 0;
+    }
+
+    return 1;
+}
+
 sub sig_complete {
     my ( $complist, $window, $word, $linestart, $want_space ) = @_;
 
@@ -847,6 +904,8 @@ Irssi::settings_add_str( "twirssi", "twirssi_location",
     ".irssi/scripts/twirssi.pl" );
 Irssi::settings_add_str( "twirssi", "twitter_usernames", undef );
 Irssi::settings_add_str( "twirssi", "twitter_passwords", undef );
+Irssi::settings_add_str( "twirssi", "twirssi_replies_store",
+    ".irssi/scripts/twirssi.json" );
 Irssi::settings_add_bool( "twirssi", "tweet_to_away",             0 );
 Irssi::settings_add_bool( "twirssi", "show_reply_context",        0 );
 Irssi::settings_add_bool( "twirssi", "show_own_tweets",           1 );
@@ -872,20 +931,24 @@ if ($window) {
         Irssi::command_bind( "reply_as", "cmd_reply_as" );
     }
     Irssi::command_bind(
-        "twitter_dump",
+        "twirssi_dump",
         sub {
-            print "twits: ",   Dumper \%twits;
+            print "twits: ", join ", ",
+              map { "u: $_->{username}" } values %twits;
             print "friends: ", join ", ", sort keys %friends;
             print "nicks: ",   join ", ", sort keys %nicks;
+            print "id_map: ", Dumper \%{ $id_map{__indexes} };
             print "last poll: $last_poll";
         }
     );
     Irssi::command_bind(
         "twirssi_version",
         sub {
-            &notice(
-"Twirssi v$VERSION (r$REV);  Net::Twitter v$Net::Twitter::VERSION. "
-                  . "See details at http://tinyurl.com/twirssi" );
+            &notice("Twirssi v$VERSION (r$REV); "
+                  . "Net::Twitter v$Net::Twitter::VERSION. "
+                  . "JSON in use: "
+                  . JSON::Any::handler()
+                  . ".  See details at http://twirssi.com/" );
         }
     );
     Irssi::command_bind(
@@ -912,6 +975,24 @@ if ($window) {
     &notice(
         "    %Y||%C `%N Log in with /twitter_login, send updates with /tweet");
 
+    my $file = Irssi::settings_get_str("twirssi_replies_store");
+    if ( $file and -r $file ) {
+        if ( open( JSON, $file ) ) {
+            local $/;
+            my $json = <JSON>;
+            close JSON;
+            eval {
+                my $ref = JSON::Any->jsonToObj($json);
+                %id_map = %$ref;
+                my $num = keys %{ $id_map{__indexes} };
+                &notice( sprintf "Loaded old replies from %d contact%s.",
+                    $num, ( $num == 1 ? "" : "s" ) );
+            };
+        } else {
+            &notice("Failed to load old replies from $file: $!");
+        }
+    }
+
     if ( my $provider = Irssi::settings_get_str("short_url_provider") ) {
         eval "use WWW::Shorten::$provider;";