[e54f2fa] | 1 | use warnings; |
---|
| 2 | use strict; |
---|
| 3 | |
---|
| 4 | =head1 NAME |
---|
| 5 | |
---|
| 6 | BarnOwl::Module::Twitter |
---|
| 7 | |
---|
| 8 | =head1 DESCRIPTION |
---|
| 9 | |
---|
| 10 | Post outgoing zephyrs from -c $USER -i status -O TWITTER to Twitter |
---|
| 11 | |
---|
| 12 | =cut |
---|
| 13 | |
---|
| 14 | package BarnOwl::Module::Twitter; |
---|
| 15 | |
---|
[159aaad] | 16 | our $VERSION = 0.2; |
---|
[af3415c] | 17 | |
---|
[e54f2fa] | 18 | use Net::Twitter; |
---|
| 19 | use JSON; |
---|
[efcd223] | 20 | use List::Util qw(first); |
---|
[e54f2fa] | 21 | |
---|
| 22 | use BarnOwl; |
---|
| 23 | use BarnOwl::Hooks; |
---|
[159aaad] | 24 | use BarnOwl::Module::Twitter::Handle; |
---|
[e54f2fa] | 25 | |
---|
[d748296] | 26 | our @twitter_handles = (); |
---|
| 27 | our $default_handle = undef; |
---|
[9bedca0] | 28 | my $user = BarnOwl::zephyr_getsender(); |
---|
| 29 | my ($class) = ($user =~ /(^[^@]+)/); |
---|
| 30 | my $instance = "status"; |
---|
| 31 | my $opcode = "twitter"; |
---|
[d658c29] | 32 | my $use_reply_to = 0; |
---|
[159aaad] | 33 | my $next_service_to_poll = 0; |
---|
[188b745] | 34 | |
---|
[d689fc7] | 35 | my $desc = <<'END_DESC'; |
---|
[d1bb4f3] | 36 | BarnOwl::Module::Twitter will watch for authentic zephyrs to |
---|
| 37 | -c $twitter:class -i $twitter:instance -O $twitter:opcode |
---|
| 38 | from your sender and mirror them to Twitter. |
---|
| 39 | |
---|
| 40 | A value of '*' in any of these fields acts a wildcard, accepting |
---|
| 41 | messages with any value of that field. |
---|
| 42 | END_DESC |
---|
[d689fc7] | 43 | BarnOwl::new_variable_string( |
---|
| 44 | 'twitter:class', |
---|
| 45 | { |
---|
| 46 | default => $class, |
---|
| 47 | summary => 'Class to watch for Twitter messages', |
---|
| 48 | description => $desc |
---|
| 49 | } |
---|
| 50 | ); |
---|
| 51 | BarnOwl::new_variable_string( |
---|
| 52 | 'twitter:instance', |
---|
| 53 | { |
---|
| 54 | default => $instance, |
---|
| 55 | summary => 'Instance on twitter:class to watch for Twitter messages.', |
---|
| 56 | description => $desc |
---|
| 57 | } |
---|
| 58 | ); |
---|
| 59 | BarnOwl::new_variable_string( |
---|
| 60 | 'twitter:opcode', |
---|
| 61 | { |
---|
| 62 | default => $opcode, |
---|
| 63 | summary => 'Opcode for zephyrs that will be sent as twitter updates', |
---|
| 64 | description => $desc |
---|
| 65 | } |
---|
| 66 | ); |
---|
[e54f2fa] | 67 | |
---|
[927c186] | 68 | BarnOwl::new_variable_bool( |
---|
| 69 | 'twitter:poll', |
---|
| 70 | { |
---|
| 71 | default => 1, |
---|
| 72 | summary => 'Poll Twitter for incoming messages', |
---|
| 73 | description => "If set, will poll Twitter every minute for normal updates,\n" |
---|
| 74 | . 'and every two minutes for direct message' |
---|
| 75 | } |
---|
| 76 | ); |
---|
| 77 | |
---|
[159aaad] | 78 | sub fail { |
---|
| 79 | my $msg = shift; |
---|
| 80 | undef @twitter_handles; |
---|
| 81 | BarnOwl::admin_message('Twitter Error', $msg); |
---|
| 82 | die("Twitter Error: $msg\n"); |
---|
| 83 | } |
---|
| 84 | |
---|
[d775050] | 85 | my $conffile = BarnOwl::get_config_dir() . "/twitter"; |
---|
| 86 | open(my $fh, "<", "$conffile") || fail("Unable to read $conffile"); |
---|
[159aaad] | 87 | my $raw_cfg = do {local $/; <$fh>}; |
---|
[e54f2fa] | 88 | close($fh); |
---|
| 89 | eval { |
---|
[159aaad] | 90 | $raw_cfg = from_json($raw_cfg); |
---|
[e54f2fa] | 91 | }; |
---|
[9bedca0] | 92 | if($@) { |
---|
[159aaad] | 93 | fail("Unable to parse $conffile: $@"); |
---|
[e54f2fa] | 94 | } |
---|
| 95 | |
---|
[159aaad] | 96 | $raw_cfg = [$raw_cfg] unless UNIVERSAL::isa $raw_cfg, "ARRAY"; |
---|
| 97 | |
---|
| 98 | for my $cfg (@$raw_cfg) { |
---|
| 99 | my $twitter_args = { username => $cfg->{user} || $user, |
---|
| 100 | password => $cfg->{password}, |
---|
| 101 | source => 'barnowl', |
---|
| 102 | }; |
---|
| 103 | if (defined $cfg->{service}) { |
---|
| 104 | my $service = $cfg->{service}; |
---|
| 105 | $twitter_args->{apiurl} = $service; |
---|
| 106 | my $apihost = $service; |
---|
| 107 | $apihost =~ s/^\s*http:\/\///; |
---|
| 108 | $apihost =~ s/\/.*$//; |
---|
| 109 | $apihost .= ':80' unless $apihost =~ /:\d+$/; |
---|
| 110 | $twitter_args->{apihost} = $cfg->{apihost} || $apihost; |
---|
| 111 | my $apirealm = "Laconica API"; |
---|
| 112 | $twitter_args->{apirealm} = $cfg->{apirealm} || $apirealm; |
---|
| 113 | } else { |
---|
| 114 | $cfg->{service} = 'http://twitter.com'; |
---|
| 115 | } |
---|
[b56f2c3] | 116 | |
---|
[39dd366] | 117 | my $twitter_handle; |
---|
[d748296] | 118 | eval { |
---|
[39dd366] | 119 | $twitter_handle = BarnOwl::Module::Twitter::Handle->new($cfg, %$twitter_args); |
---|
[d748296] | 120 | }; |
---|
[39dd366] | 121 | if ($@) { |
---|
| 122 | BarnOwl::error($@); |
---|
| 123 | next; |
---|
| 124 | } |
---|
| 125 | push @twitter_handles, $twitter_handle; |
---|
[efcd223] | 126 | } |
---|
| 127 | |
---|
| 128 | $default_handle = first {$_->{cfg}->{default_sender}} @twitter_handles; |
---|
| 129 | if (!$default_handle && @twitter_handles) { |
---|
| 130 | $default_handle = $twitter_handles[0]; |
---|
[b56f2c3] | 131 | } |
---|
| 132 | |
---|
[d1bb4f3] | 133 | sub match { |
---|
| 134 | my $val = shift; |
---|
| 135 | my $pat = shift; |
---|
| 136 | return $pat eq "*" || ($val eq $pat); |
---|
| 137 | } |
---|
| 138 | |
---|
[e54f2fa] | 139 | sub handle_message { |
---|
| 140 | my $m = shift; |
---|
| 141 | ($class, $instance, $opcode) = map{BarnOwl::getvar("twitter:$_")} qw(class instance opcode); |
---|
| 142 | if($m->sender eq $user |
---|
[d1bb4f3] | 143 | && match($m->class, $class) |
---|
| 144 | && match($m->instance, $instance) |
---|
| 145 | && match($m->opcode, $opcode) |
---|
[e54f2fa] | 146 | && $m->auth eq 'YES') { |
---|
[159aaad] | 147 | for my $handle (@twitter_handles) { |
---|
[efcd223] | 148 | $handle->twitter($m->body) if $handle->{cfg}->{publish_tweets}; |
---|
[159aaad] | 149 | } |
---|
[e54f2fa] | 150 | } |
---|
| 151 | } |
---|
| 152 | |
---|
[8618438] | 153 | sub poll_messages { |
---|
[d748296] | 154 | return unless @twitter_handles; |
---|
| 155 | |
---|
[159aaad] | 156 | my $handle = $twitter_handles[$next_service_to_poll]; |
---|
| 157 | $next_service_to_poll = ($next_service_to_poll + 1) % scalar(@twitter_handles); |
---|
| 158 | |
---|
[efcd223] | 159 | $handle->poll_twitter() if $handle->{cfg}->{poll_for_tweets}; |
---|
| 160 | $handle->poll_direct() if $handle->{cfg}->{poll_for_dms}; |
---|
| 161 | } |
---|
| 162 | |
---|
| 163 | sub find_account { |
---|
| 164 | my $name = shift; |
---|
| 165 | my $handle = first {$_->{cfg}->{account_nickname} eq $name} @twitter_handles; |
---|
| 166 | if ($handle) { |
---|
| 167 | return $handle; |
---|
| 168 | } else { |
---|
| 169 | die("No such Twitter account: $name\n"); |
---|
| 170 | } |
---|
[927c186] | 171 | } |
---|
| 172 | |
---|
[159aaad] | 173 | sub twitter { |
---|
| 174 | my $account = shift; |
---|
| 175 | |
---|
| 176 | my $sent = 0; |
---|
| 177 | if (defined $account) { |
---|
[efcd223] | 178 | my $handle = find_account($account); |
---|
| 179 | $handle->twitter(@_); |
---|
[159aaad] | 180 | } |
---|
| 181 | else { |
---|
| 182 | # broadcast |
---|
| 183 | for my $handle (@twitter_handles) { |
---|
[efcd223] | 184 | $handle->twitter(@_) if $handle->{cfg}->{publish_tweets}; |
---|
[159aaad] | 185 | } |
---|
[8618438] | 186 | } |
---|
| 187 | } |
---|
| 188 | |
---|
[159aaad] | 189 | sub twitter_direct { |
---|
| 190 | my $account = shift; |
---|
| 191 | |
---|
| 192 | my $sent = 0; |
---|
| 193 | if (defined $account) { |
---|
[efcd223] | 194 | my $handle = find_account($account); |
---|
| 195 | $handle->twitter_direct(@_); |
---|
| 196 | } elsif (defined $default_handle) { |
---|
[159aaad] | 197 | $default_handle->twitter_direct(@_); |
---|
[9bedca0] | 198 | } |
---|
[159aaad] | 199 | else { |
---|
| 200 | $twitter_handles[0]->twitter_direct(@_); |
---|
[927c186] | 201 | } |
---|
| 202 | } |
---|
| 203 | |
---|
[6babb75] | 204 | sub twitter_atreply { |
---|
[159aaad] | 205 | my $account = shift; |
---|
| 206 | |
---|
| 207 | my $sent = 0; |
---|
| 208 | if (defined $account) { |
---|
[efcd223] | 209 | my $handle = find_account($account); |
---|
| 210 | $handle->twitter_atreply(@_); |
---|
[159aaad] | 211 | } |
---|
| 212 | elsif (defined $default_handle) { |
---|
| 213 | $default_handle->twitter_atreply(@_); |
---|
| 214 | } |
---|
| 215 | else { |
---|
| 216 | $twitter_handles[0]->twitter_atreply(@_); |
---|
[acdd52e] | 217 | } |
---|
[6babb75] | 218 | } |
---|
| 219 | |
---|
[4cf4067] | 220 | BarnOwl::new_command(twitter => \&cmd_twitter, { |
---|
| 221 | summary => 'Update Twitter from BarnOwl', |
---|
[159aaad] | 222 | usage => 'twitter [ACCOUNT] [MESSAGE]', |
---|
| 223 | description => 'Update Twitter on ACCOUNT. If MESSAGE is provided, use it as your status.' |
---|
| 224 | . "\nIf no ACCOUNT is provided, update all services which have publishing enabled." |
---|
[4cf4067] | 225 | . "\nOtherwise, prompt for a status message to use." |
---|
| 226 | }); |
---|
| 227 | |
---|
[927c186] | 228 | BarnOwl::new_command('twitter-direct' => \&cmd_twitter_direct, { |
---|
| 229 | summary => 'Send a Twitter direct message', |
---|
[159aaad] | 230 | usage => 'twitter-direct USER [ACCOUNT]', |
---|
| 231 | description => 'Send a Twitter Direct Message to USER on ACCOUNT (defaults to default_sender,' |
---|
| 232 | . "\nor first service if no default is provided)" |
---|
[927c186] | 233 | }); |
---|
| 234 | |
---|
[6babb75] | 235 | BarnOwl::new_command( 'twitter-atreply' => sub { cmd_twitter_atreply(@_); }, |
---|
| 236 | { |
---|
| 237 | summary => 'Send a Twitter @ message', |
---|
[159aaad] | 238 | usage => 'twitter-atreply USER [ACCOUNT]', |
---|
| 239 | description => 'Send a Twitter @reply Message to USER on ACCOUNT (defaults to default_sender,' |
---|
| 240 | . "or first service if no default is provided)" |
---|
[6babb75] | 241 | } |
---|
| 242 | ); |
---|
| 243 | |
---|
| 244 | |
---|
[4cf4067] | 245 | sub cmd_twitter { |
---|
| 246 | my $cmd = shift; |
---|
[159aaad] | 247 | my $account = shift; |
---|
| 248 | if (defined $account) { |
---|
| 249 | if(@_) { |
---|
| 250 | my $status = join(" ", @_); |
---|
| 251 | twitter($account, $status); |
---|
| 252 | return; |
---|
| 253 | } |
---|
[4cf4067] | 254 | } |
---|
[159aaad] | 255 | BarnOwl::start_edit_win('What are you doing?' . (defined $account ? " ($account)" : ""), sub{twitter($account, shift)}); |
---|
[4cf4067] | 256 | } |
---|
| 257 | |
---|
[927c186] | 258 | sub cmd_twitter_direct { |
---|
| 259 | my $cmd = shift; |
---|
| 260 | my $user = shift; |
---|
| 261 | die("Usage: $cmd USER\n") unless $user; |
---|
[159aaad] | 262 | my $account = shift; |
---|
| 263 | BarnOwl::start_edit_win("$cmd $user" . (defined $account ? " $account" : ""), sub{twitter_direct($account, $user, shift)}); |
---|
[927c186] | 264 | } |
---|
| 265 | |
---|
[6babb75] | 266 | sub cmd_twitter_atreply { |
---|
| 267 | my $cmd = shift; |
---|
[acdd52e] | 268 | my $user = shift || die("Usage: $cmd USER [In-Reply-To ID]\n"); |
---|
| 269 | my $id = shift; |
---|
[159aaad] | 270 | my $account = shift; |
---|
| 271 | BarnOwl::start_edit_win("Reply to \@" . $user . (defined $account ? " on $account" : ""), sub { twitter_atreply($account, $user, $id, shift) }); |
---|
[6babb75] | 272 | } |
---|
| 273 | |
---|
[72b61dd] | 274 | eval { |
---|
| 275 | $BarnOwl::Hooks::receiveMessage->add("BarnOwl::Module::Twitter::handle_message"); |
---|
[8618438] | 276 | $BarnOwl::Hooks::mainLoop->add("BarnOwl::Module::Twitter::poll_messages"); |
---|
[72b61dd] | 277 | }; |
---|
| 278 | if($@) { |
---|
| 279 | $BarnOwl::Hooks::receiveMessage->add(\&handle_message); |
---|
[8618438] | 280 | $BarnOwl::Hooks::mainLoop->add(\&poll_messages); |
---|
[72b61dd] | 281 | } |
---|
[e54f2fa] | 282 | |
---|
[f93b81b] | 283 | BarnOwl::filter(qw{twitter type ^twitter$}); |
---|
[8618438] | 284 | |
---|
[e54f2fa] | 285 | 1; |
---|