3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, Controlez-Vous, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('LACONICA')) { exit(1); }
22 class TwitterapiAction extends Action {
24 function handle($args) {
25 parent::handle($args);
28 function twitter_user_array($profile, $get_notice=false) {
30 $twitter_user = array();
32 $twitter_user['name'] = $profile->getBestName();
33 $twitter_user['followers_count'] = $this->count_subscriptions($profile);
34 $twitter_user['screen_name'] = $profile->nickname;
35 $twitter_user['description'] = ($profile->bio) ? $profile->bio : NULL;
36 $twitter_user['location'] = ($profile->location) ? $profile->location : NULL;
37 $twitter_user['id'] = intval($profile->id);
39 $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
41 $twitter_user['profile_image_url'] = ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE);
42 $twitter_user['protected'] = false; # not supported by Laconica yet
43 $twitter_user['url'] = ($profile->homepage) ? $profile->homepage : NULL;
46 $notice = $profile->getCurrentNotice();
49 $twitter_user['status'] = $this->twitter_status_array($notice, false);
56 function twitter_status_array($notice, $get_user=true) {
58 $twitter_status = array();
60 $twitter_status['text'] = $notice->content;
61 $twitter_status['truncated'] = false; # Not possible on Laconica
62 $twitter_status['created_at'] = $this->date_twitter($notice->created);
63 $twitter_status['in_reply_to_status_id'] = ($notice->reply_to) ? intval($notice->reply_to) : NULL;
64 $twitter_status['source'] = NULL; # XXX: twitterific, twitterfox, etc. Not supported yet.
65 $twitter_status['id'] = intval($notice->id);
66 $twitter_status['in_reply_to_user_id'] = ($notice->reply_to) ? $this->replier_by_reply($notice->reply_to) : NULL;
67 $twitter_status['favorited'] = NULL; # XXX: Not implemented on Laconica yet.
70 $profile = $notice->getProfile();
71 # Don't get notice (recursive!)
72 $twitter_user = $this->twitter_user_array($profile, false);
73 $twitter_status['user'] = $twitter_user;
76 return $twitter_status;
79 function twitter_rss_entry_array($notice) {
81 $profile = $notice->getProfile();
83 $server = common_config('site', 'server');
86 $entry['content'] = $profile->nickname . ': ' . $notice->content;
87 $entry['title'] = $entry['content'];
88 $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));;
89 $entry['published'] = common_date_iso8601($notice->created);
90 $entry['id'] = "tag:$server,$entry[published]:$entry[link]";
91 $entry['updated'] = $entry['published'];
94 $entry['description'] = $entry['content'];
95 $entry['pubDate'] = common_date_rfc2822($notice->created);
96 $entry['guid'] = $entry['link'];
101 function show_twitter_xml_status($twitter_status) {
102 common_element_start('status');
103 common_element('created_at', NULL, $twitter_status['created_at']);
104 common_element('id', NULL, $twitter_status['id']);
105 common_element('text', NULL, $twitter_status['text']);
106 common_element('source', NULL, $twitter_status['source']);
107 common_element('truncated', NULL, $twitter_status['truncated']);
108 common_element('in_reply_to_status_id', NULL, $twitter_status['in_reply_to_status_id']);
109 common_element('in_reply_to_user_id', NULL, $twitter_status['in_reply_to_user_id']);
110 common_element('favorited', Null, $twitter_status['favorited']);
112 if ($twitter_status['user']) {
113 $this->show_twitter_xml_user($twitter_status['user']);
116 common_element_end('status');
119 function show_twitter_xml_user($twitter_user) {
120 common_element_start('user');
121 common_element('id', NULL, $twitter_user['id']);
122 common_element('name', NULL, $twitter_user['name']);
123 common_element('screen_name', NULL, $twitter_user['screen_name']);
124 common_element('location', NULL, $twitter_user['location']);
125 common_element('description', NULL, $twitter_user['description']);
126 common_element('profile_image_url', NULL, $twitter_user['profile_image_url']);
127 common_element('url', NULL, $twitter_user['url']);
128 common_element('protected', NULL, $twitter_user['protected']);
129 common_element('followers_count', NULL, $twitter_user['followers_count']);
130 if ($twitter_user['status']) {
131 $this->show_twitter_xml_status($twitter_user['status']);
133 common_element_end('user');
136 function show_twitter_rss_item($entry) {
137 common_element_start('item');
138 common_element('title', NULL, $entry['title']);
139 common_element('description', NULL, $entry['description']);
140 common_element('pubDate', NULL, $entry['pubDate']);
141 common_element('guid', NULL, $entry['guid']);
142 common_element('link', NULL, $entry['link']);
143 common_element_end('item');
146 function show_twitter_atom_entry($entry) {
147 common_element_start('entry');
148 common_element('title', NULL, $entry['title']);
149 common_element('content', array('type' => 'html'), $entry['title']);
150 common_element('id', NULL, $entry['id']);
151 common_element('published', NULL, $entry['published']);
152 common_element('updated', NULL, $entry['updated']);
153 common_element('link', array('href' => $entry['link'], 'rel' => 'alternate', 'type' => 'text/html'), NULL);
154 common_element_end('entry');
157 function show_twitter_json_statuses($twitter_statuses) {
158 print(json_encode($twitter_statuses));
161 function show_twitter_json_users($twitter_users) {
162 print(json_encode($twitter_users));
165 function show($args, $apidata) {
166 parent::handle($args);
168 $id = $apidata['api_arg'];
169 $notice = Notice::staticGet($id);
173 if ($apidata['content-type'] == 'xml') {
174 $this->show_single_xml_status($notice);
175 } elseif ($apidata['content-type'] == 'json') {
176 $this->show_single_json_status($notice);
179 header('HTTP/1.1 404 Not Found');
185 function show_single_xml_status($notice) {
186 header('Content-Type: application/xml; charset=utf-8');
188 $twitter_status = $this->twitter_status_array($notice);
189 $this->show_twitter_xml_status($twitter_status);
194 function show_single_json_status($notice) {
195 header('Content-Type: application/json; charset=utf-8');
196 $status = $this->twitter_status_array($notice);
197 $this->show_twitter_json_statuses($status);
201 // Anyone know what date format this is?
202 // Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach
203 function date_twitter($dt) {
205 return date("D M d G:i:s O Y", $t);
208 function replier_by_reply($reply_id) {
210 $notice = Notice::staticGet($reply_id);
213 common_debug("TwitterapiAction::replier_by_reply: Got a bad notice_id: $reply_id");
216 $profile = $notice->getProfile();
219 common_debug("TwitterapiAction::replier_by_reply: Got a bad profile_id: $profile_id");
223 return intval($profile->id);
226 // XXX: Candidate for a general utility method somewhere?
227 function count_subscriptions($profile) {
230 $sub = new Subscription();
231 $sub->subscribed = $profile->id;
233 $count = $sub->find();
242 function init_document($type='xml') {
245 header('Content-Type: application/xml; charset=utf-8');
249 header('Content-Type: application/json; charset=utf-8');
252 header("Content-Type: application/rss+xml; charset=utf-8");
253 $this->init_twitter_rss();
256 header('Content-Type: application/atom+xml; charset=utf-8');
257 $this->init_twitter_atom();
260 $this->client_error(_('Unsupported type'));
265 function end_document($type='xml') {
273 $this->end_twitter_rss();
276 $this->end_twitter_rss();
279 $this->client_error(_('Unsupported type'));
284 function client_error($msg, $code = 400, $content_type = 'json') {
286 static $status = array(400 => 'Bad Request',
287 401 => 'Unauthorized',
288 402 => 'Payment Required',
291 405 => 'Method Not Allowed',
292 406 => 'Not Acceptable',
293 407 => 'Proxy Authentication Required',
294 408 => 'Request Timeout',
297 411 => 'Length Required',
298 412 => 'Precondition Failed',
299 413 => 'Request Entity Too Large',
300 414 => 'Request-URI Too Long',
301 415 => 'Unsupported Media Type',
302 416 => 'Requested Range Not Satisfiable',
303 417 => 'Expectation Failed');
305 $action = $this->trimmed('action');
307 common_debug("User error '$code' on '$action': $msg", __FILE__);
309 if (!array_key_exists($code, $status)) {
313 $status_string = $status[$code];
314 header('HTTP/1.1 '.$code.' '.$status_string);
316 if ($content_type == 'xml') {
318 common_element_start('hash');
319 common_element('error', NULL, $msg);
320 common_element('request', NULL, $_SERVER['REQUEST_URI']);
321 common_element_end('hash');
324 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
325 print(json_encode($error_array));
331 function init_twitter_rss() {
333 common_element_start('rss', array('version' => '2.0'));
336 function end_twitter_rss() {
337 common_element_end('rss');
341 function init_twitter_atom() {
343 common_element_start('feed', array('xmlns' => 'http://www.w3.org/2005/Atom', 'xml:lang' => 'en-US'));
346 function end_twitter_atom() {
348 common_element_end('feed');
351 function show_profile($profile, $content_type='xml', $notice=NULL) {
352 $profile_array = $this->twitter_user_array($profile, true);
353 switch ($content_type) {
355 $this->show_twitter_xml_user($profile_array);
358 $this->show_twitter_json_users($profile_array);
361 $this->client_error(_('not a supported data format'));