source: lib/BarnOwl/Module/Twitter.pm @ 22fce654

release-1.7release-1.8release-1.9
Last change on this file since 22fce654 was 22fce654, checked in by Nelson Elhage <nelhage@mit.edu>, 10 years ago
Update the prompt to match Twitter.
  • Property mode set to 100644
File size: 10.0 KB
Line 
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
16our $VERSION = 0.2;
17
18use Net::Twitter;
19use JSON;
20use List::Util qw(first);
21
22use BarnOwl;
23use BarnOwl::Hooks;
24use BarnOwl::Module::Twitter::Handle;
25
26our @twitter_handles = ();
27our $default_handle = undef;
28my $class    = $ENV{USER};
29my $instance = "status";
30my $opcode   = "twitter";
31my $use_reply_to = 0;
32my $next_service_to_poll = 0;
33
34my $desc = <<'END_DESC';
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
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);
66
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
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
84my $conffile = BarnOwl::get_config_dir() . "/twitter";
85open(my $fh, "<", "$conffile") || fail("Unable to read $conffile");
86my $raw_cfg = do {local $/; <$fh>};
87close($fh);
88eval {
89    $raw_cfg = from_json($raw_cfg);
90};
91if($@) {
92    fail("Unable to parse $conffile: $@");
93}
94
95$raw_cfg = [$raw_cfg] unless UNIVERSAL::isa $raw_cfg, "ARRAY";
96
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}) {
108            fail("Account $user has no password set.");
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
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
133for my $cfg (@$raw_cfg) {
134    my $twitter_args = { username   => $cfg->{user},
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    }
151
152    my $twitter_handle;
153    eval {
154         $twitter_handle = BarnOwl::Module::Twitter::Handle->new($cfg, %$twitter_args);
155    };
156    if ($@) {
157        BarnOwl::error($@);
158        next;
159    }
160    push @twitter_handles, $twitter_handle;
161}
162
163$default_handle = first {$_->{cfg}->{default}} @twitter_handles;
164if (!$default_handle && @twitter_handles) {
165    $default_handle = $twitter_handles[0];
166}
167
168sub match {
169    my $val = shift;
170    my $pat = shift;
171    return $pat eq "*" || ($val eq $pat);
172}
173
174sub handle_message {
175    my $m = shift;
176    ($class, $instance, $opcode) = map{BarnOwl::getvar("twitter:$_")} qw(class instance opcode);
177    if($m->type eq 'zephyr'
178       && $m->sender eq BarnOwl::zephyr_getsender()
179       && match($m->class, $class)
180       && match($m->instance, $instance)
181       && match($m->opcode, $opcode)
182       && $m->auth eq 'YES') {
183        for my $handle (@twitter_handles) {
184            $handle->twitter($m->body) if $handle->{cfg}->{publish_tweets};
185        }
186    }
187}
188
189sub poll_messages {
190    return unless @twitter_handles;
191
192    my $handle = $twitter_handles[$next_service_to_poll];
193    $next_service_to_poll = ($next_service_to_poll + 1) % scalar(@twitter_handles);
194   
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    }
207}
208
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
218sub twitter {
219    my $account = shift;
220
221    my $sent = 0;
222    if (defined $account) {
223        my $handle = find_account($account);
224        $handle->twitter(@_);
225    } 
226    else {
227        # broadcast
228        for my $handle (@twitter_handles) {
229            $handle->twitter(@_) if $handle->{cfg}->{publish_tweets};
230        }
231    }
232}
233
234BarnOwl::new_command(twitter => \&cmd_twitter, {
235    summary     => 'Update Twitter from BarnOwl',
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."
239    . "\nOtherwise, prompt for a status message to use."
240   });
241
242BarnOwl::new_command('twitter-direct' => \&cmd_twitter_direct, {
243    summary     => 'Send a Twitter direct message',
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)"
247   });
248
249BarnOwl::new_command( 'twitter-atreply' => sub { cmd_twitter_atreply(@_); },
250    {
251    summary     => 'Send a Twitter @ message',
252    usage       => 'twitter-atreply USER [ACCOUNT]',
253    description => 'Send a Twitter @reply Message to USER on ACCOUNT (defaults to default_sender,' 
254    . "\nor first service if no default is provided)"
255    }
256);
257
258BarnOwl::new_command( 'twitter-retweet' => sub { cmd_twitter_retweet(@_) },
259    {
260    summary     => 'Retweet the current Twitter message',
261    usage       => 'twitter-retweet [ACCOUNT]',
262    description => <<END_DESCRIPTION
263Retweet the current Twitter message using ACCOUNT (defaults to the
264account that received the tweet).
265END_DESCRIPTION
266    }
267);
268
269BarnOwl::new_command( 'twitter-follow' => sub { cmd_twitter_follow(@_); },
270    {
271    summary     => 'Follow a user on Twitter',
272    usage       => 'twitter-follow USER [ACCOUNT]',
273    description => 'Follow USER on Twitter ACCOUNT (defaults to default_sender, or first service'
274    . "\nif no default is provided)"
275    }
276);
277
278BarnOwl::new_command( 'twitter-unfollow' => sub { cmd_twitter_unfollow(@_); },
279    {
280    summary     => 'Stop following a user on Twitter',
281    usage       => 'twitter-unfollow USER [ACCOUNT]',
282    description => 'Stop following USER on Twitter ACCOUNT (defaults to default_sender, or first'
283    . "\nservice if no default is provided)"
284    }
285);
286
287sub cmd_twitter {
288    my $cmd = shift;
289    my $account = shift;
290    if (defined $account) {
291        if(@_) {
292            my $status = join(" ", @_);
293            twitter($account, $status);
294            return;
295        }
296    }
297    BarnOwl::start_edit_win("What's happening?" . (defined $account ? " ($account)" : ""), sub{twitter($account, shift)});
298}
299
300sub cmd_twitter_direct {
301    my $cmd = shift;
302    my $user = shift;
303    die("Usage: $cmd USER\n") unless $user;
304    my $account = find_account_default(shift);
305    BarnOwl::start_edit_win("$cmd $user " . ($account->nickname||""),
306                            sub { $account->twitter_direct($user, shift) });
307}
308
309sub cmd_twitter_atreply {
310    my $cmd  = shift;
311    my $user = shift || die("Usage: $cmd USER [In-Reply-To ID]\n");
312    my $id   = shift;
313    my $account = find_account_default(shift);
314
315    BarnOwl::start_edit_win("Reply to \@" . $user . ($account->nickname ? (" on " . $account->nickname) : ""),
316                            sub { $account->twitter_atreply($user, $id, shift) });
317}
318
319sub cmd_twitter_retweet {
320    my $cmd = shift;
321    my $account = shift;
322    my $m = BarnOwl::getcurmsg();
323    if(!$m || $m->type ne 'Twitter') {
324        die("$cmd must be used with a Twitter message selected.\n");
325    }
326
327    $account = $m->account unless defined($account);
328    find_account($account)->twitter_retweet($m);
329}
330
331sub cmd_twitter_follow {
332    my $cmd = shift;
333    my $user = shift;
334    die("Usage: $cmd USER\n") unless $user;
335    my $account = shift;
336    find_account_default($account)->twitter_follow($user);
337}
338
339sub cmd_twitter_unfollow {
340    my $cmd = shift;
341    my $user = shift;
342    die("Usage: $cmd USER\n") unless $user;
343    my $account = shift;
344    find_account_default($account)->twitter_unfollow($user);
345}
346
347eval {
348    $BarnOwl::Hooks::receiveMessage->add("BarnOwl::Module::Twitter::handle_message");
349    $BarnOwl::Hooks::mainLoop->add("BarnOwl::Module::Twitter::poll_messages");
350};
351if($@) {
352    $BarnOwl::Hooks::receiveMessage->add(\&handle_message);
353    $BarnOwl::Hooks::mainLoop->add(\&poll_messages);
354}
355
356BarnOwl::filter(qw{twitter type ^twitter$});
357
3581;
Note: See TracBrowser for help on using the repository browser.