From 3df358a9e98328de4d865b91a5900f834a1f195a Mon Sep 17 00:00:00 2001 From: zach Date: Tue, 15 Jul 2008 00:31:21 -0400 Subject: Prepended 'Twit' to Twitter-compatible API actions (renamed action files) to make it more clear what the action files are for. darcs-hash:20080715043121-ca946-bb7acd42271117dbb77d5e16292673a4b8cfad53.gz --- actions/api.php | 2 +- actions/apiaccount.php | 55 ------- actions/apiblocks.php | 38 ----- actions/apidirect_messages.php | 51 ------- actions/apifavorites.php | 44 ------ actions/apifriendships.php | 45 ------ actions/apihelp.php | 52 ------- actions/apinotifications.php | 40 ----- actions/apistatuses.php | 302 ------------------------------------- actions/twitapiaccount.php | 55 +++++++ actions/twitapiblocks.php | 38 +++++ actions/twitapidirect_messages.php | 51 +++++++ actions/twitapifavorites.php | 44 ++++++ actions/twitapifriendships.php | 45 ++++++ actions/twitapihelp.php | 52 +++++++ actions/twitapinotifications.php | 40 +++++ actions/twitapistatuses.php | 302 +++++++++++++++++++++++++++++++++++++ 17 files changed, 628 insertions(+), 628 deletions(-) delete mode 100644 actions/apiaccount.php delete mode 100644 actions/apiblocks.php delete mode 100644 actions/apidirect_messages.php delete mode 100644 actions/apifavorites.php delete mode 100644 actions/apifriendships.php delete mode 100644 actions/apihelp.php delete mode 100644 actions/apinotifications.php delete mode 100644 actions/apistatuses.php create mode 100644 actions/twitapiaccount.php create mode 100644 actions/twitapiblocks.php create mode 100644 actions/twitapidirect_messages.php create mode 100644 actions/twitapifavorites.php create mode 100644 actions/twitapifriendships.php create mode 100644 actions/twitapihelp.php create mode 100644 actions/twitapinotifications.php create mode 100644 actions/twitapistatuses.php diff --git a/actions/api.php b/actions/api.php index 2e7ed3558..badd4a42a 100644 --- a/actions/api.php +++ b/actions/api.php @@ -76,7 +76,7 @@ class ApiAction extends Action { } function process_command() { - $action = "api$this->api_action"; + $action = "twitapi$this->api_action"; $actionfile = INSTALLDIR."/actions/$action.php"; if (file_exists($actionfile)) { require_once($actionfile); diff --git a/actions/apiaccount.php b/actions/apiaccount.php deleted file mode 100644 index 2be53122e..000000000 --- a/actions/apiaccount.php +++ /dev/null @@ -1,55 +0,0 @@ -. - */ - -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/twitterapi.php'); - -class ApiaccountAction extends TwitterapiAction { - - function verify_credentials($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function end_session($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function update_location($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function update_delivery_device($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function rate_limit_status($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } -} \ No newline at end of file diff --git a/actions/apiblocks.php b/actions/apiblocks.php deleted file mode 100644 index c9c7a0082..000000000 --- a/actions/apiblocks.php +++ /dev/null @@ -1,38 +0,0 @@ -. - */ - -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/twitterapi.php'); - -class ApiblocksAction extends TwitterapiAction { - - function create($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function destroy($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - -} \ No newline at end of file diff --git a/actions/apidirect_messages.php b/actions/apidirect_messages.php deleted file mode 100644 index 351a4bb29..000000000 --- a/actions/apidirect_messages.php +++ /dev/null @@ -1,51 +0,0 @@ -. - */ - -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/twitterapi.php'); - -class Apidirect_messagesAction extends TwitterapiAction { - - function direct_messages($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function sent($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - # had to change this from "new" to "create" to avoid PHP reserved word - function create($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function destroy($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - -} \ No newline at end of file diff --git a/actions/apifavorites.php b/actions/apifavorites.php deleted file mode 100644 index db8ad1062..000000000 --- a/actions/apifavorites.php +++ /dev/null @@ -1,44 +0,0 @@ -. - */ - -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/twitterapi.php'); - -class ApifavoritesAction extends TwitterapiAction { - - function favorites($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function create($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function destroy($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - -} \ No newline at end of file diff --git a/actions/apifriendships.php b/actions/apifriendships.php deleted file mode 100644 index 4368f84d5..000000000 --- a/actions/apifriendships.php +++ /dev/null @@ -1,45 +0,0 @@ -. - */ - -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/twitterapi.php'); - -class ApifriendshipsAction extends TwitterapiAction { - - - function create($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function destroy($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function exists($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - -} \ No newline at end of file diff --git a/actions/apihelp.php b/actions/apihelp.php deleted file mode 100644 index 66a08c99a..000000000 --- a/actions/apihelp.php +++ /dev/null @@ -1,52 +0,0 @@ -. - */ - -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/twitterapi.php'); - -class ApihelpAction extends TwitterapiAction { - - /* Returns the string "ok" in the requested format with a 200 OK HTTP status code. - * URL:http://identi.ca/api/help/test.format - * Formats: xml, json - */ - function test($args, $apidata) { - global $xw; - if ($apidata['content-type'] == 'xml') { - header('Content-Type: application/xml; charset=utf-8'); - common_start_xml(); - common_element('ok', NULL, 'true'); - common_end_xml(); - } elseif ($apidata['content-type'] == 'json') { - header('Content-Type: application/json; charset=utf-8'); - print '"ok"'; - } else { - common_user_error("API method not found!", $code=404); - } - exit(); - } - - function downtime_schedule($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - -} \ No newline at end of file diff --git a/actions/apinotifications.php b/actions/apinotifications.php deleted file mode 100644 index 98d96107d..000000000 --- a/actions/apinotifications.php +++ /dev/null @@ -1,40 +0,0 @@ -. - */ - -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/twitterapi.php'); - -# This naming convention looks real sick -class ApinotificationsAction extends TwitterapiAction { - - - function follow($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - - function leave($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - exit(); - } - -} \ No newline at end of file diff --git a/actions/apistatuses.php b/actions/apistatuses.php deleted file mode 100644 index b43823643..000000000 --- a/actions/apistatuses.php +++ /dev/null @@ -1,302 +0,0 @@ -. - */ - -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/twitterapi.php'); - -/* XXX: Please don't freak out about all the ugly comments in this file. - * They are mostly in here for reference while I work on the - * API. I'll fix things up to make them look better later. -- Zach - */ -class ApistatusesAction extends TwitterapiAction { - - /* - * Returns the 20 most recent statuses from non-protected users who have set a custom - * user icon. Does not require authentication. - * - * URL: http://identi.ca/api/statuses/public_timeline.format - * - * Formats: xml, json, rss, atom - */ - function public_timeline($args, $apidata) { - parent::handle($args); - - if ($apidata['content-type'] == 'xml') { - header('Content-Type: application/xml; charset=utf-8'); - $notice = DB_DataObject::factory('notice'); - - # FIXME: bad performance - $notice->whereAdd('EXISTS (SELECT user.id from user where user.id = notice.profile_id)'); - $notice->orderBy('created DESC, notice.id DESC'); - $notice->limit(20); - $cnt = $notice->find(); - - common_start_xml(); - - // XXX: To really live up to the spec we need to build a list - // of notices by users who have custom avatars - if ($cnt > 0) { - common_element_start('statuses', array('type' => 'array')); - for ($i = 0; $i < 20; $i++) { - if ($notice->fetch()) { - $this->show_xml_status($notice); - } else { - // shouldn't happen! - break; - } - } - common_element_end('statuses'); - } - - common_end_xml(); - } elseif ($apidata['content-type'] == 'rss') { - common_server_error("API method under construction.", $code=501); - } elseif ($apidata['content-type'] == 'atom') { - common_server_error("API method under construction.", $code=501); - } elseif ($apidata['content-type'] == 'json') { - common_server_error("API method under construction.", $code=501); - } - - exit(); - } - - - - /* - Returns the 20 most recent statuses posted by the authenticating user and that user's friends. - This is the equivalent of /home on the Web. - - URL: http://identi.ca/api/statuses/friends_timeline.format - - Parameters: - - * since. Optional. Narrows the returned results to just those statuses created after the specified - HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in - your HTTP request. - Ex: http://identi.ca/api/statuses/friends_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT - * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than) - the specified ID. Ex: http://identi.ca/api/statuses/friends_timeline.xml?since_id=12345 - * count. Optional. Specifies the number of statuses to retrieve. May not be greater than 200. - Ex: http://identi.ca/api/statuses/friends_timeline.xml?count=5 - * page. Optional. Ex: http://identi.ca/api/statuses/friends_timeline.rss?page=3 - - Formats: xml, json, rss, atom - */ - function friends_timeline($args, $apidata) { - parent::handle($args); - - $since = $this->arg('since'); - $since_id = $this->arg('since_id'); - $count = $this->arg('count'); - $page = $this->arg('page'); - - print "Friends Timeline! requested content-type: " . $apidata['content-type'] . "\n"; - print "since: $since, since_id: $since_id, count: $count, page: $page\n"; - - exit(); - - } - - /* - Returns the 20 most recent statuses posted from the authenticating user. It's also possible to - request another user's timeline via the id parameter below. This is the equivalent of the Web - /archive page for your own user, or the profile page for a third party. - - URL: http://identi.ca/api/statuses/user_timeline.format - - Formats: xml, json, rss, atom - - Parameters: - - * id. Optional. Specifies the ID or screen name of the user for whom to return the - friends_timeline. Ex: http://identi.ca/api/statuses/user_timeline/12345.xml or - http://identi.ca/api/statuses/user_timeline/bob.json. - * count. Optional. Specifies the number of - statuses to retrieve. May not be greater than 200. Ex: - http://identi.ca/api/statuses/user_timeline.xml?count=5 - * since. Optional. Narrows the returned - results to just those statuses created after the specified HTTP-formatted date. The same - behavior is available by setting an If-Modified-Since header in your HTTP request. Ex: - http://identi.ca/api/statuses/user_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT - * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than) - the specified ID. Ex: http://identi.ca/api/statuses/user_timeline.xml?since_id=12345 * page. - Optional. Ex: http://identi.ca/api/statuses/friends_timeline.rss?page=3 - */ - function user_timeline($args, $apidata) { - parent::handle($args); - - $id = $this->arg('id'); - $count = $this->arg('count'); - $since = $this->arg('since'); - $since_id = $this->arg('since_id'); - - print "User Timeline! requested content-type: " . $apidata['content-type'] . "\n"; - print "id: $id since: $since, since_id: $since_id, count: $count\n"; - - exit(); - } - - /* - Returns a single status, specified by the id parameter below. The status's author will be returned inline. - - URL: http://identi.ca/api/statuses/show/id.format - - Formats: xml, json - - Parameters: - - * id. Required. The numerical ID of the status you're trying to retrieve. - Ex: http://identi.ca/api/statuses/show/123.xml - */ - function show($args, $apidata) { - parent::handle($args); - - $id = $this->arg('id'); - - print "show requested content-type: " . $apidata['content-type'] . "\n"; - print "id: $id\n"; - - exit(); - - } - - /* - Updates the authenticating user's status. Requires the status parameter specified below. Request must be a POST. - - URL: http://identi.ca/api/statuses/update.format - - Formats: xml, json. Returns the posted status in requested format when successful. - - Parameters: - - * status. Required. The text of your status update. Be sure to URL encode as necessary. Must not be more than 160 - characters and should not be more than 140 characters to ensure optimal display. - - */ - function update($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - } - - /* - Returns the 20 most recent @replies (status updates prefixed with @username) for the authenticating user. - URL: http://identi.ca/api/statuses/replies.format - - Formats: xml, json, rss, atom - - Parameters: - - * page. Optional. Retrieves the 20 next most recent replies. Ex: http://identi.ca/api/statuses/replies.xml?page=3 - * since. Optional. Narrows the returned results to just those replies created after the specified HTTP-formatted date. The - same behavior is available by setting an If-Modified-Since header in your HTTP request. Ex: - http://identi.ca/api/statuses/replies.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT - * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than) the specified - ID. Ex: http://identi.ca/api/statuses/replies.xml?since_id=12345 - */ - function replies($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - } - - - /* - Destroys the status specified by the required ID parameter. The authenticating user must be - the author of the specified status. - - URL: http://identi.ca/api/statuses/destroy/id.format - - Formats: xml, json - - Parameters: - - * id. Required. The ID of the status to destroy. Ex: - http://identi.ca/api/statuses/destroy/12345.json or - http://identi.ca/api/statuses/destroy/23456.xml - - */ - function destroy($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - } - - # User Methods - - /* - Returns up to 100 of the authenticating user's friends who have most recently updated, each with current status inline. - It's also possible to request another user's recent friends list via the id parameter below. - - URL: http://identi.ca/api/statuses/friends.format - - Formats: xml, json - - Parameters: - - * id. Optional. The ID or screen name of the user for whom to request a list of friends. Ex: - http://identi.ca/api/statuses/friends/12345.json - or - http://identi.ca/api/statuses/friends/bob.xml - * page. Optional. Retrieves the next 100 friends. Ex: http://identi.ca/api/statuses/friends.xml?page=2 - * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true. Ex: - http://identi.ca/api/statuses/friends.xml?lite=true - * since. Optional. Narrows the returned results to just those friendships created after the specified - HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in your HTTP - request. Ex: http://identi.ca/api/statuses/friends.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT - */ - function friends($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - } - - /* - Returns the authenticating user's followers, each with current status inline. They are ordered by the - order in which they joined Twitter (this is going to be changed). - - URL: http://identi.ca/api/statuses/followers.format - Formats: xml, json - - Parameters: - - * id. Optional. The ID or screen name of the user for whom to request a list of followers. Ex: - http://identi.ca/api/statuses/followers/12345.json - or - http://identi.ca/api/statuses/followers/bob.xml - * page. Optional. Retrieves the next 100 followers. Ex: http://identi.ca/api/statuses/followers.xml?page=2 - * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true. - Ex: http://identi.ca/api/statuses/followers.xml?lite=true - */ - function followers($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - } - - /* - Returns a list of the users currently featured on the site with their current statuses inline. - URL: http://identi.ca/api/statuses/featured.format - - Formats: xml, json - */ - function featured($args, $apidata) { - parent::handle($args); - common_server_error("API method under construction.", $code=501); - } - -} - - diff --git a/actions/twitapiaccount.php b/actions/twitapiaccount.php new file mode 100644 index 000000000..93e0844c1 --- /dev/null +++ b/actions/twitapiaccount.php @@ -0,0 +1,55 @@ +. + */ + +if (!defined('LACONICA')) { exit(1); } + +require_once(INSTALLDIR.'/lib/twitterapi.php'); + +class TwitapiaccountAction extends TwitterapiAction { + + function verify_credentials($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function end_session($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function update_location($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function update_delivery_device($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function rate_limit_status($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } +} \ No newline at end of file diff --git a/actions/twitapiblocks.php b/actions/twitapiblocks.php new file mode 100644 index 000000000..a498d2038 --- /dev/null +++ b/actions/twitapiblocks.php @@ -0,0 +1,38 @@ +. + */ + +if (!defined('LACONICA')) { exit(1); } + +require_once(INSTALLDIR.'/lib/twitterapi.php'); + +class TwitapiblocksAction extends TwitterapiAction { + + function create($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function destroy($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + +} \ No newline at end of file diff --git a/actions/twitapidirect_messages.php b/actions/twitapidirect_messages.php new file mode 100644 index 000000000..e7f3e1266 --- /dev/null +++ b/actions/twitapidirect_messages.php @@ -0,0 +1,51 @@ +. + */ + +if (!defined('LACONICA')) { exit(1); } + +require_once(INSTALLDIR.'/lib/twitterapi.php'); + +class Twitapidirect_messagesAction extends TwitterapiAction { + + function direct_messages($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function sent($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + # had to change this from "new" to "create" to avoid PHP reserved word + function create($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function destroy($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + +} \ No newline at end of file diff --git a/actions/twitapifavorites.php b/actions/twitapifavorites.php new file mode 100644 index 000000000..a4afa732a --- /dev/null +++ b/actions/twitapifavorites.php @@ -0,0 +1,44 @@ +. + */ + +if (!defined('LACONICA')) { exit(1); } + +require_once(INSTALLDIR.'/lib/twitterapi.php'); + +class TwitapifavoritesAction extends TwitterapiAction { + + function favorites($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function create($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function destroy($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + +} \ No newline at end of file diff --git a/actions/twitapifriendships.php b/actions/twitapifriendships.php new file mode 100644 index 000000000..e4888008b --- /dev/null +++ b/actions/twitapifriendships.php @@ -0,0 +1,45 @@ +. + */ + +if (!defined('LACONICA')) { exit(1); } + +require_once(INSTALLDIR.'/lib/twitterapi.php'); + +class TwitapifriendshipsAction extends TwitterapiAction { + + + function create($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function destroy($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function exists($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + +} \ No newline at end of file diff --git a/actions/twitapihelp.php b/actions/twitapihelp.php new file mode 100644 index 000000000..5a35d8442 --- /dev/null +++ b/actions/twitapihelp.php @@ -0,0 +1,52 @@ +. + */ + +if (!defined('LACONICA')) { exit(1); } + +require_once(INSTALLDIR.'/lib/twitterapi.php'); + +class TwitapihelpAction extends TwitterapiAction { + + /* Returns the string "ok" in the requested format with a 200 OK HTTP status code. + * URL:http://identi.ca/api/help/test.format + * Formats: xml, json + */ + function test($args, $apidata) { + global $xw; + if ($apidata['content-type'] == 'xml') { + header('Content-Type: application/xml; charset=utf-8'); + common_start_xml(); + common_element('ok', NULL, 'true'); + common_end_xml(); + } elseif ($apidata['content-type'] == 'json') { + header('Content-Type: application/json; charset=utf-8'); + print '"ok"'; + } else { + common_user_error("API method not found!", $code=404); + } + exit(); + } + + function downtime_schedule($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + +} \ No newline at end of file diff --git a/actions/twitapinotifications.php b/actions/twitapinotifications.php new file mode 100644 index 000000000..45a33427b --- /dev/null +++ b/actions/twitapinotifications.php @@ -0,0 +1,40 @@ +. + */ + +if (!defined('LACONICA')) { exit(1); } + +require_once(INSTALLDIR.'/lib/twitterapi.php'); + +# This naming convention looks real sick +class TwitapinotificationsAction extends TwitterapiAction { + + + function follow($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + + function leave($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + exit(); + } + +} \ No newline at end of file diff --git a/actions/twitapistatuses.php b/actions/twitapistatuses.php new file mode 100644 index 000000000..7ac9167d3 --- /dev/null +++ b/actions/twitapistatuses.php @@ -0,0 +1,302 @@ +. + */ + +if (!defined('LACONICA')) { exit(1); } + +require_once(INSTALLDIR.'/lib/twitterapi.php'); + +/* XXX: Please don't freak out about all the ugly comments in this file. + * They are mostly in here for reference while I work on the + * API. I'll fix things up to make them look better later. -- Zach + */ +class TwitapistatusesAction extends TwitterapiAction { + + /* + * Returns the 20 most recent statuses from non-protected users who have set a custom + * user icon. Does not require authentication. + * + * URL: http://identi.ca/api/statuses/public_timeline.format + * + * Formats: xml, json, rss, atom + */ + function public_timeline($args, $apidata) { + parent::handle($args); + + if ($apidata['content-type'] == 'xml') { + header('Content-Type: application/xml; charset=utf-8'); + $notice = DB_DataObject::factory('notice'); + + # FIXME: bad performance + $notice->whereAdd('EXISTS (SELECT user.id from user where user.id = notice.profile_id)'); + $notice->orderBy('created DESC, notice.id DESC'); + $notice->limit(20); + $cnt = $notice->find(); + + common_start_xml(); + + // XXX: To really live up to the spec we need to build a list + // of notices by users who have custom avatars + if ($cnt > 0) { + common_element_start('statuses', array('type' => 'array')); + for ($i = 0; $i < 20; $i++) { + if ($notice->fetch()) { + $this->show_xml_status($notice); + } else { + // shouldn't happen! + break; + } + } + common_element_end('statuses'); + } + + common_end_xml(); + } elseif ($apidata['content-type'] == 'rss') { + common_server_error("API method under construction.", $code=501); + } elseif ($apidata['content-type'] == 'atom') { + common_server_error("API method under construction.", $code=501); + } elseif ($apidata['content-type'] == 'json') { + common_server_error("API method under construction.", $code=501); + } + + exit(); + } + + + + /* + Returns the 20 most recent statuses posted by the authenticating user and that user's friends. + This is the equivalent of /home on the Web. + + URL: http://identi.ca/api/statuses/friends_timeline.format + + Parameters: + + * since. Optional. Narrows the returned results to just those statuses created after the specified + HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in + your HTTP request. + Ex: http://identi.ca/api/statuses/friends_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT + * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than) + the specified ID. Ex: http://identi.ca/api/statuses/friends_timeline.xml?since_id=12345 + * count. Optional. Specifies the number of statuses to retrieve. May not be greater than 200. + Ex: http://identi.ca/api/statuses/friends_timeline.xml?count=5 + * page. Optional. Ex: http://identi.ca/api/statuses/friends_timeline.rss?page=3 + + Formats: xml, json, rss, atom + */ + function friends_timeline($args, $apidata) { + parent::handle($args); + + $since = $this->arg('since'); + $since_id = $this->arg('since_id'); + $count = $this->arg('count'); + $page = $this->arg('page'); + + print "Friends Timeline! requested content-type: " . $apidata['content-type'] . "\n"; + print "since: $since, since_id: $since_id, count: $count, page: $page\n"; + + exit(); + + } + + /* + Returns the 20 most recent statuses posted from the authenticating user. It's also possible to + request another user's timeline via the id parameter below. This is the equivalent of the Web + /archive page for your own user, or the profile page for a third party. + + URL: http://identi.ca/api/statuses/user_timeline.format + + Formats: xml, json, rss, atom + + Parameters: + + * id. Optional. Specifies the ID or screen name of the user for whom to return the + friends_timeline. Ex: http://identi.ca/api/statuses/user_timeline/12345.xml or + http://identi.ca/api/statuses/user_timeline/bob.json. + * count. Optional. Specifies the number of + statuses to retrieve. May not be greater than 200. Ex: + http://identi.ca/api/statuses/user_timeline.xml?count=5 + * since. Optional. Narrows the returned + results to just those statuses created after the specified HTTP-formatted date. The same + behavior is available by setting an If-Modified-Since header in your HTTP request. Ex: + http://identi.ca/api/statuses/user_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT + * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than) + the specified ID. Ex: http://identi.ca/api/statuses/user_timeline.xml?since_id=12345 * page. + Optional. Ex: http://identi.ca/api/statuses/friends_timeline.rss?page=3 + */ + function user_timeline($args, $apidata) { + parent::handle($args); + + $id = $this->arg('id'); + $count = $this->arg('count'); + $since = $this->arg('since'); + $since_id = $this->arg('since_id'); + + print "User Timeline! requested content-type: " . $apidata['content-type'] . "\n"; + print "id: $id since: $since, since_id: $since_id, count: $count\n"; + + exit(); + } + + /* + Returns a single status, specified by the id parameter below. The status's author will be returned inline. + + URL: http://identi.ca/api/statuses/show/id.format + + Formats: xml, json + + Parameters: + + * id. Required. The numerical ID of the status you're trying to retrieve. + Ex: http://identi.ca/api/statuses/show/123.xml + */ + function show($args, $apidata) { + parent::handle($args); + + $id = $this->arg('id'); + + print "show requested content-type: " . $apidata['content-type'] . "\n"; + print "id: $id\n"; + + exit(); + + } + + /* + Updates the authenticating user's status. Requires the status parameter specified below. Request must be a POST. + + URL: http://identi.ca/api/statuses/update.format + + Formats: xml, json. Returns the posted status in requested format when successful. + + Parameters: + + * status. Required. The text of your status update. Be sure to URL encode as necessary. Must not be more than 160 + characters and should not be more than 140 characters to ensure optimal display. + + */ + function update($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + } + + /* + Returns the 20 most recent @replies (status updates prefixed with @username) for the authenticating user. + URL: http://identi.ca/api/statuses/replies.format + + Formats: xml, json, rss, atom + + Parameters: + + * page. Optional. Retrieves the 20 next most recent replies. Ex: http://identi.ca/api/statuses/replies.xml?page=3 + * since. Optional. Narrows the returned results to just those replies created after the specified HTTP-formatted date. The + same behavior is available by setting an If-Modified-Since header in your HTTP request. Ex: + http://identi.ca/api/statuses/replies.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT + * since_id. Optional. Returns only statuses with an ID greater than (that is, more recent than) the specified + ID. Ex: http://identi.ca/api/statuses/replies.xml?since_id=12345 + */ + function replies($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + } + + + /* + Destroys the status specified by the required ID parameter. The authenticating user must be + the author of the specified status. + + URL: http://identi.ca/api/statuses/destroy/id.format + + Formats: xml, json + + Parameters: + + * id. Required. The ID of the status to destroy. Ex: + http://identi.ca/api/statuses/destroy/12345.json or + http://identi.ca/api/statuses/destroy/23456.xml + + */ + function destroy($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + } + + # User Methods + + /* + Returns up to 100 of the authenticating user's friends who have most recently updated, each with current status inline. + It's also possible to request another user's recent friends list via the id parameter below. + + URL: http://identi.ca/api/statuses/friends.format + + Formats: xml, json + + Parameters: + + * id. Optional. The ID or screen name of the user for whom to request a list of friends. Ex: + http://identi.ca/api/statuses/friends/12345.json + or + http://identi.ca/api/statuses/friends/bob.xml + * page. Optional. Retrieves the next 100 friends. Ex: http://identi.ca/api/statuses/friends.xml?page=2 + * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true. Ex: + http://identi.ca/api/statuses/friends.xml?lite=true + * since. Optional. Narrows the returned results to just those friendships created after the specified + HTTP-formatted date. The same behavior is available by setting an If-Modified-Since header in your HTTP + request. Ex: http://identi.ca/api/statuses/friends.xml?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT + */ + function friends($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + } + + /* + Returns the authenticating user's followers, each with current status inline. They are ordered by the + order in which they joined Twitter (this is going to be changed). + + URL: http://identi.ca/api/statuses/followers.format + Formats: xml, json + + Parameters: + + * id. Optional. The ID or screen name of the user for whom to request a list of followers. Ex: + http://identi.ca/api/statuses/followers/12345.json + or + http://identi.ca/api/statuses/followers/bob.xml + * page. Optional. Retrieves the next 100 followers. Ex: http://identi.ca/api/statuses/followers.xml?page=2 + * lite. Optional. Prevents the inline inclusion of current status. Must be set to a value of true. + Ex: http://identi.ca/api/statuses/followers.xml?lite=true + */ + function followers($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + } + + /* + Returns a list of the users currently featured on the site with their current statuses inline. + URL: http://identi.ca/api/statuses/featured.format + + Formats: xml, json + */ + function featured($args, $apidata) { + parent::handle($args); + common_server_error("API method under construction.", $code=501); + } + +} + + -- cgit v1.2.3-54-g00ecf