source: lib/BarnOwl/Module/Twitter.pm @ 7ec65f5

release-1.7release-1.8release-1.9
Last change on this file since 7ec65f5 was 176434d, checked in by Nelson Elhage <nelhage@mit.edu>, 13 years ago
Don't check zephyr_getsender unless we're looking at a Zephyr.
  • Property mode set to 100644
File size: 9.4 KB
RevLine 
[e54f2fa]1use warnings;
2use strict;
3
4=head1 NAME
5
6BarnOwl::Module::Twitter
7
8=head1 DESCRIPTION
9
10Post outgoing zephyrs from -c $USER -i status -O TWITTER to Twitter
11
12=cut
13
14package BarnOwl::Module::Twitter;
15
[159aaad]16our $VERSION = 0.2;
[af3415c]17
[e54f2fa]18use Net::Twitter;
19use JSON;
[efcd223]20use List::Util qw(first);
[e54f2fa]21
22use BarnOwl;
23use BarnOwl::Hooks;
[159aaad]24use BarnOwl::Module::Twitter::Handle;
[e54f2fa]25
[d748296]26our @twitter_handles = ();
27our $default_handle = undef;
[9eb9479]28my $class    = $ENV{USER};
[9bedca0]29my $instance = "status";
30my $opcode   = "twitter";
[d658c29]31my $use_reply_to = 0;
[159aaad]32my $next_service_to_poll = 0;
[188b745]33
[d689fc7]34my $desc = <<'END_DESC';
[d1bb4f3]35BarnOwl::Module::Twitter will watch for authentic zephyrs to
36-c $twitter:class -i $twitter:instance -O $twitter:opcode
37from your sender and mirror them to Twitter.
38
39A value of '*' in any of these fields acts a wildcard, accepting
40messages with any value of that field.
41END_DESC
[d689fc7]42BarnOwl::new_variable_string(
43    'twitter:class',
44    {
45        default     => $class,
46        summary     => 'Class to watch for Twitter messages',
47        description => $desc
48    }
49);
50BarnOwl::new_variable_string(
51    'twitter:instance',
52    {
53        default => $instance,
54        summary => 'Instance on twitter:class to watch for Twitter messages.',
55        description => $desc
56    }
57);
58BarnOwl::new_variable_string(
59    'twitter:opcode',
60    {
61        default => $opcode,
62        summary => 'Opcode for zephyrs that will be sent as twitter updates',
63        description => $desc
64    }
65);
[e54f2fa]66
[927c186]67BarnOwl::new_variable_bool(
68    'twitter:poll',
69    {
70        default => 1,
71        summary => 'Poll Twitter for incoming messages',
72        description => "If set, will poll Twitter every minute for normal updates,\n"
73        . 'and every two minutes for direct message'
74     }
75 );
76
[159aaad]77sub fail {
78    my $msg = shift;
79    undef @twitter_handles;
80    BarnOwl::admin_message('Twitter Error', $msg);
81    die("Twitter Error: $msg\n");
82}
83
[d775050]84my $conffile = BarnOwl::get_config_dir() . "/twitter";
85open(my $fh, "<", "$conffile") || fail("Unable to read $conffile");
[159aaad]86my $raw_cfg = do {local $/; <$fh>};
[e54f2fa]87close($fh);
88eval {
[159aaad]89    $raw_cfg = from_json($raw_cfg);
[e54f2fa]90};
[9bedca0]91if($@) {
[159aaad]92    fail("Unable to parse $conffile: $@");
[e54f2fa]93}
94
[159aaad]95$raw_cfg = [$raw_cfg] unless UNIVERSAL::isa $raw_cfg, "ARRAY";
96
[e010ee0]97# Perform some sanity checking on the configuration.
98{
99    my %nicks;
100    my $default = 0;
101
102    for my $cfg (@$raw_cfg) {
103        if(! exists $cfg->{user}) {
104            fail("Account has no username set.");
105        }
106        my $user = $cfg->{user};
107        if(! exists $cfg->{password}) {
[2fa9f803]108            fail("Account $user has no password set.");
[e010ee0]109        }
110        if(@$raw_cfg > 1&&
111           !exists($cfg->{account_nickname}) ) {
112            fail("Account $user has no account_nickname set.");
113        }
114        if($cfg->{account_nickname}) {
115            if($nicks{$cfg->{account_nickname}}++) {
116                fail("Nickname " . $cfg->{account_nickname} . " specified more than once.");
117            }
118        }
119        if($cfg->{default} || $cfg->{default_sender}) {
120            if($default++) {
121                fail("Multiple accounts marked as 'default'.");
122            }
123        }
124    }
125}
126
[f0de278]127# If there is only a single account, make publish_tweets default to
128# true.
129if (scalar @$raw_cfg == 1 && !exists($raw_cfg->[0]{publish_tweets})) {
130    $raw_cfg->[0]{publish_tweets} = 1;
131}
132
[159aaad]133for my $cfg (@$raw_cfg) {
[9eb9479]134    my $twitter_args = { username   => $cfg->{user},
[159aaad]135                        password   => $cfg->{password},
136                        source     => 'barnowl', 
137                    };
138    if (defined $cfg->{service}) {
139        my $service = $cfg->{service};
140        $twitter_args->{apiurl} = $service;
141        my $apihost = $service;
142        $apihost =~ s/^\s*http:\/\///;
143        $apihost =~ s/\/.*$//;
144        $apihost .= ':80' unless $apihost =~ /:\d+$/;
145        $twitter_args->{apihost} = $cfg->{apihost} || $apihost;
146        my $apirealm = "Laconica API";
147        $twitter_args->{apirealm} = $cfg->{apirealm} || $apirealm;
148    } else {
149        $cfg->{service} = 'http://twitter.com';
150    }
[b56f2c3]151
[39dd366]152    my $twitter_handle;
[d748296]153    eval {
[39dd366]154         $twitter_handle = BarnOwl::Module::Twitter::Handle->new($cfg, %$twitter_args);
[d748296]155    };
[39dd366]156    if ($@) {
157        BarnOwl::error($@);
158        next;
159    }
160    push @twitter_handles, $twitter_handle;
[efcd223]161}
162
[385dd69]163$default_handle = first {$_->{cfg}->{default}} @twitter_handles;
[efcd223]164if (!$default_handle && @twitter_handles) {
165    $default_handle = $twitter_handles[0];
[b56f2c3]166}
167
[d1bb4f3]168sub match {
169    my $val = shift;
170    my $pat = shift;
171    return $pat eq "*" || ($val eq $pat);
172}
173
[e54f2fa]174sub handle_message {
175    my $m = shift;
176    ($class, $instance, $opcode) = map{BarnOwl::getvar("twitter:$_")} qw(class instance opcode);
[176434d]177    if($m->type eq 'zephyr'
178       && $m->sender eq BarnOwl::zephyr_getsender()
[d1bb4f3]179       && match($m->class, $class)
180       && match($m->instance, $instance)
181       && match($m->opcode, $opcode)
[e54f2fa]182       && $m->auth eq 'YES') {
[159aaad]183        for my $handle (@twitter_handles) {
[efcd223]184            $handle->twitter($m->body) if $handle->{cfg}->{publish_tweets};
[159aaad]185        }
[e54f2fa]186    }
187}
188
[8618438]189sub poll_messages {
[d748296]190    return unless @twitter_handles;
191
[159aaad]192    my $handle = $twitter_handles[$next_service_to_poll];
193    $next_service_to_poll = ($next_service_to_poll + 1) % scalar(@twitter_handles);
194   
[efcd223]195    $handle->poll_twitter() if $handle->{cfg}->{poll_for_tweets};
196    $handle->poll_direct() if $handle->{cfg}->{poll_for_dms};
197}
198
199sub find_account {
200    my $name = shift;
201    my $handle = first {$_->{cfg}->{account_nickname} eq $name} @twitter_handles;
202    if ($handle) {
203        return $handle;
204    } else {
205        die("No such Twitter account: $name\n");
206    }
[927c186]207}
208
[8462b38]209sub find_account_default {
210    my $name = shift;
211    if(defined($name)) {
212        return find_account($name);
213    } else {
214        return $default_handle;
215    }
216}
217
[159aaad]218sub twitter {
219    my $account = shift;
220
221    my $sent = 0;
222    if (defined $account) {
[efcd223]223        my $handle = find_account($account);
224        $handle->twitter(@_);
[159aaad]225    } 
226    else {
227        # broadcast
228        for my $handle (@twitter_handles) {
[efcd223]229            $handle->twitter(@_) if $handle->{cfg}->{publish_tweets};
[159aaad]230        }
[8618438]231    }
232}
233
[4cf4067]234BarnOwl::new_command(twitter => \&cmd_twitter, {
235    summary     => 'Update Twitter from BarnOwl',
[159aaad]236    usage       => 'twitter [ACCOUNT] [MESSAGE]',
237    description => 'Update Twitter on ACCOUNT. If MESSAGE is provided, use it as your status.'
238    . "\nIf no ACCOUNT is provided, update all services which have publishing enabled."
[4cf4067]239    . "\nOtherwise, prompt for a status message to use."
240   });
241
[927c186]242BarnOwl::new_command('twitter-direct' => \&cmd_twitter_direct, {
243    summary     => 'Send a Twitter direct message',
[159aaad]244    usage       => 'twitter-direct USER [ACCOUNT]',
245    description => 'Send a Twitter Direct Message to USER on ACCOUNT (defaults to default_sender,'
246    . "\nor first service if no default is provided)"
[927c186]247   });
248
[6babb75]249BarnOwl::new_command( 'twitter-atreply' => sub { cmd_twitter_atreply(@_); },
250    {
251    summary     => 'Send a Twitter @ message',
[159aaad]252    usage       => 'twitter-atreply USER [ACCOUNT]',
253    description => 'Send a Twitter @reply Message to USER on ACCOUNT (defaults to default_sender,' 
[513da71]254    . "\nor first service if no default is provided)"
255    }
256);
257
258BarnOwl::new_command( 'twitter-follow' => sub { cmd_twitter_follow(@_); },
259    {
260    summary     => 'Follow a user on Twitter',
261    usage       => 'twitter-follow USER [ACCOUNT]',
262    description => 'Follow USER on Twitter ACCOUNT (defaults to default_sender, or first service'
263    . "\nif no default is provided)"
[6babb75]264    }
265);
266
[513da71]267BarnOwl::new_command( 'twitter-unfollow' => sub { cmd_twitter_unfollow(@_); },
268    {
269    summary     => 'Stop following a user on Twitter',
270    usage       => 'twitter-unfollow USER [ACCOUNT]',
271    description => 'Stop following USER on Twitter ACCOUNT (defaults to default_sender, or first'
272    . "\nservice if no default is provided)"
273    }
274);
[6babb75]275
[4cf4067]276sub cmd_twitter {
277    my $cmd = shift;
[159aaad]278    my $account = shift;
279    if (defined $account) {
280        if(@_) {
281            my $status = join(" ", @_);
282            twitter($account, $status);
283            return;
284        }
[4cf4067]285    }
[159aaad]286    BarnOwl::start_edit_win('What are you doing?' . (defined $account ? " ($account)" : ""), sub{twitter($account, shift)});
[4cf4067]287}
288
[927c186]289sub cmd_twitter_direct {
290    my $cmd = shift;
291    my $user = shift;
292    die("Usage: $cmd USER\n") unless $user;
[8462b38]293    my $account = find_account_default(shift);
294    BarnOwl::start_edit_win("$cmd $user " . ($account->nickname||""),
295                            sub { $account->twitter_direct($user, shift) });
[927c186]296}
297
[6babb75]298sub cmd_twitter_atreply {
299    my $cmd  = shift;
[acdd52e]300    my $user = shift || die("Usage: $cmd USER [In-Reply-To ID]\n");
301    my $id   = shift;
[8462b38]302    my $account = find_account_default(shift);
303
304    BarnOwl::start_edit_win("Reply to \@" . $user . ($account->nickname ? (" on " . $account->nickname) : ""),
305                            sub { $account->twitter_atreply($user, $id, shift) });
[6babb75]306}
307
[513da71]308sub cmd_twitter_follow {
309    my $cmd = shift;
310    my $user = shift;
311    die("Usage: $cmd USER\n") unless $user;
312    my $account = shift;
[8462b38]313    find_account_default($account)->twitter_follow($user);
[513da71]314}
315
316sub cmd_twitter_unfollow {
317    my $cmd = shift;
318    my $user = shift;
319    die("Usage: $cmd USER\n") unless $user;
320    my $account = shift;
[8462b38]321    find_account_default($account)->twitter_unfollow($user);
[513da71]322}
323
[72b61dd]324eval {
325    $BarnOwl::Hooks::receiveMessage->add("BarnOwl::Module::Twitter::handle_message");
[8618438]326    $BarnOwl::Hooks::mainLoop->add("BarnOwl::Module::Twitter::poll_messages");
[72b61dd]327};
328if($@) {
329    $BarnOwl::Hooks::receiveMessage->add(\&handle_message);
[8618438]330    $BarnOwl::Hooks::mainLoop->add(\&poll_messages);
[72b61dd]331}
[e54f2fa]332
[f93b81b]333BarnOwl::filter(qw{twitter type ^twitter$});
[8618438]334
[e54f2fa]3351;
Note: See TracBrowser for help on using the repository browser.