diff options
| -rw-r--r-- | actions/apiaccount.php | 19 | ||||
| -rw-r--r-- | actions/apidirect_messages.php | 10 | ||||
| -rw-r--r-- | actions/apifavorites.php | 43 | ||||
| -rw-r--r-- | actions/apistatuses.php | 197 | ||||
| -rw-r--r-- | htaccess.sample | 20 |
5 files changed, 269 insertions, 20 deletions
diff --git a/actions/apiaccount.php b/actions/apiaccount.php index ecbb88570..6d5766916 100644 --- a/actions/apiaccount.php +++ b/actions/apiaccount.php @@ -20,25 +20,36 @@ if (!defined('LACONICA')) { exit(1); } # This naming convention looks real sick -class ApifavoritesAction extends Action { +class ApiaccountAction extends Action { - function index($args, $apidata) { + function verify_credentials($args, $apidata) { parent::handle($args); common_server_error("API method under construction.", $code=501); exit(); } - function create($args, $apidata) { + function end_session($args, $apidata) { parent::handle($args); common_server_error("API method under construction.", $code=501); exit(); } - function destroy($args, $apidata) { + 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/apidirect_messages.php b/actions/apidirect_messages.php index 125aad128..477aa4329 100644 --- a/actions/apidirect_messages.php +++ b/actions/apidirect_messages.php @@ -19,11 +19,9 @@ if (!defined('LACONICA')) { exit(1); } -# This naming convention looks real sick class Apidirect_messagesAction extends Action { - - function index($args, $apidata) { + function direct_messages($args, $apidata) { parent::handle($args); common_server_error("API method under construction.", $code=501); exit(); @@ -35,17 +33,17 @@ class Apidirect_messagesAction extends Action { exit(); } - function new($args, $apidata) { + # 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 index e69de29bb..358079c86 100644 --- a/actions/apifavorites.php +++ b/actions/apifavorites.php @@ -0,0 +1,43 @@ +<?php +/* + * Laconica - a distributed open-source microblogging tool + * Copyright (C) 2008, Controlez-Vous, Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +if (!defined('LACONICA')) { exit(1); } + +# This naming convention looks real sick +class ApifavoritesAction extends Action { + + 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/apistatuses.php b/actions/apistatuses.php index 728a43180..89eabfcdc 100644 --- a/actions/apistatuses.php +++ b/actions/apistatuses.php @@ -19,37 +19,180 @@ if (!defined('LACONICA')) { exit(1); } +/* XXX: Please don't freak out about all the ugly comments in this file. + * They are mostly in here for reference while I develop the + * API. I'll fix things up to make them look better later. -- Zach + */ class ApistatusesAction extends Action { + + /* + Returns the 20 most recent statuses from non-protected users who have set a custom user icon. + Does not require authentication. - function public_timeline($args) { + URL: http://identi.ca/api/statuses/public_timeline.format + + Formats: xml, json, rss, atom + */ + function public_timeline($args, $apidata) { + parent::handle($args); + + print "Public Timeline! requested content-type: " . $apidata['content-type'] . "\n"; + + 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); - print "Public Timeline!\n"; + $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); - common_debug("statuses/show"); - print_r($args); - print_r($apidata); + $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); @@ -57,16 +200,60 @@ class ApistatusesAction extends Action { # 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/htaccess.sample b/htaccess.sample index 3a5198925..4ee0d6212 100644 --- a/htaccess.sample +++ b/htaccess.sample @@ -56,12 +56,22 @@ RewriteRule ^(\w+)/avatar/(original|96|48|24)$ index.php?action=avatarbynickname RewriteRule ^(\w+)$ index.php?action=showstream&nickname=$1 [L,QSA] -# Twitter-compatible API rewrites +# Twitter-compatible API rewrites +# XXX: Surely these can be refactored a little -- Zach RewriteRule ^api/statuses/public_timeline(.*)$ index.php?action=api&apiaction=statuses&method=public_timeline$1 [L,QSA] +RewriteRule ^api/statuses/friends_timeline(.*)$ index.php?action=api&apiaction=statuses&method=friends_timeline$1 [L,QSA] +RewriteRule ^api/statuses/user_timeline(.*)$ index.php?action=api&apiaction=statuses&method=user_timeline$1 [L,QSA] RewriteRule ^api/statuses/show/(.*)$ index.php?action=api&apiaction=statuses&method=show&argument=$1 [L,QSA] -RewriteRule ^api/statuses/direct_messages/sent(.*)$ index.php?action=api&apiaction=direct_messages&method=send$1 [L,QSA] -RewriteRule ^api/statuses/direct_messages(.*)$ index.php?action=api&apiaction=direct_messages&method=index$1 [L,QSA] -RewriteRule ^api/direct_messages/(.*)$ index.php?action=api&apiaction=direct_messages&method=$1 [L,QSA] +RewriteRule ^api/statuses/update/(.*)$ index.php?action=api&apiaction=statuses&method=update&argument=$1 [L,QSA] +RewriteRule ^api/statuses/replies/(.*)$ index.php?action=api&apiaction=statuses&method=replies&argument=$1 [L,QSA] +RewriteRule ^api/statuses/destroy/(.*)$ index.php?action=api&apiaction=statuses&method=destroy&argument=$1 [L,QSA] +RewriteRule ^api/statuses/friends(.*)$ index.php?action=api&apiaction=statuses&method=friends$1 [L,QSA] +RewriteRule ^api/statuses/followers(.*)$ index.php?action=api&apiaction=statuses&method=followers$1 [L,QSA] +RewriteRule ^api/statuses/featured(.*)$ index.php?action=api&apiaction=statuses&method=featured$1 [L,QSA] +RewriteRule ^api/direct_messages/sent(.*)$ index.php?action=api&apiaction=direct_messages&method=sent$1 [L,QSA] +RewriteRule ^api/direct_messages/destroy/(.*)$ index.php?action=api&apiaction=direct_messages&method=destroy&argument=$1 [L,QSA] +RewriteRule ^api/direct_messages/new(.*)$ index.php?action=api&apiaction=direct_messages&method=create$1 [L,QSA] +RewriteRule ^api/direct_messages(.*)$ index.php?action=api&apiaction=direct_messages&method=direct_messages$1 [L,QSA] RewriteRule ^api/friendships/create/(.*)$ index.php?action=api&apiaction=friendships&method=create&argument=$1 [L,QSA] RewriteRule ^api/friendships/destroy/(.*)$ index.php?action=api&apiaction=friendships&method=destroy&argument=$1 [L,QSA] RewriteRule ^api/friendships/exists(.*)$ index.php?action=api&apiaction=friendships&method=exists$1 [L,QSA] @@ -70,9 +80,9 @@ RewriteRule ^api/account/end_session$ index.php?action=api&apiaction=account&met RewriteRule ^api/account/update_location(.*)$ index.php?action=api&apiaction=account&method=update_location$1 [L,QSA] RewriteRule ^api/account/update_delivery_device(.*)$ index.php?action=api&apiaction=account&method=update_delivery_device$1 [L,QSA] RewriteRule ^api/account/rate_limit_status(.*)$ index.php?action=api&apiaction=account&method=rate_limit_status$1 [L,QSA] -RewriteRule ^api/favorites(.*)$ index.php?action=api&apiaction=favorites&method=index$1 [L,QSA] RewriteRule ^api/favorites/create/(.*)$ index.php?action=api&apiaction=favorites&method=create&argument=$1 [L,QSA] RewriteRule ^api/favorites/destroy/(.*)$ index.php?action=api&apiaction=favorites&method=destroy&argument=$1 [L,QSA] +RewriteRule ^api/favorites(.*)$ index.php?action=api&apiaction=favorites&method=favorites$1 [L,QSA] RewriteRule ^api/notifications/follow/(.*)$ index.php?action=api&apiaction=notifications&method=follow&argument=$1 [L,QSA] RewriteRule ^api/notifications/leave/(.*)$ index.php?action=api&apiaction=notifications&method=leave&argument=$1 [L,QSA] RewriteRule ^api/blocks/create/(.*)$ index.php?action=api&apiaction=blocks&method=create&argument=$1 [L,QSA] |