3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, 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('STATUSNET') && !defined('LACONICA')) { exit(1); }
22 class ApiAction extends Action
31 function handle($args)
33 parent::handle($args);
35 $this->api_action = $this->arg('apiaction');
36 $method = $this->arg('method');
37 $argument = $this->arg('argument');
39 if (isset($argument)) {
40 $cmdext = explode('.', $argument);
41 $this->api_arg = $cmdext[0];
42 $this->api_method = $method;
43 $this->content_type = strtolower($cmdext[1]);
46 # Requested format / content-type will be an extension on the method
47 $cmdext = explode('.', $method);
48 $this->api_method = $cmdext[0];
49 $this->content_type = strtolower($cmdext[1]);
52 if ($this->requires_auth()) {
53 if (!isset($_SERVER['PHP_AUTH_USER'])) {
55 # This header makes basic auth go
56 header('WWW-Authenticate: Basic realm="StatusNet API"');
58 # If the user hits cancel -- bam!
59 $this->show_basic_auth_error();
61 $nickname = $_SERVER['PHP_AUTH_USER'];
62 $password = $_SERVER['PHP_AUTH_PW'];
63 $user = common_check_user($nickname, $password);
67 $this->process_command();
69 # basic authentication failed
70 list($proxy, $ip) = common_client_ip();
72 common_log(LOG_WARNING, "Failed API auth attempt, nickname = $nickname, proxy = $proxy, ip = $ip.");
73 $this->show_basic_auth_error();
78 // Caller might give us a username even if not required
79 if (isset($_SERVER['PHP_AUTH_USER'])) {
80 $user = User::staticGet('nickname', $_SERVER['PHP_AUTH_USER']);
84 # Twitter doesn't throw an error if the user isn't found
87 $this->process_command();
91 function process_command()
93 $action = "twitapi$this->api_action";
94 $actionfile = INSTALLDIR."/actions/$action.php";
96 if (file_exists($actionfile)) {
97 require_once($actionfile);
98 $action_class = ucfirst($action)."Action";
99 $action_obj = new $action_class();
101 if (!$action_obj->prepare($this->args)) {
105 if (method_exists($action_obj, $this->api_method)) {
106 $apidata = array( 'content-type' => $this->content_type,
107 'api_method' => $this->api_method,
108 'api_arg' => $this->api_arg,
109 'user' => $this->user);
111 call_user_func(array($action_obj, $this->api_method), $_REQUEST, $apidata);
113 $this->clientError("API method not found!", $code=404);
116 $this->clientError("API method not found!", $code=404);
120 // Whitelist of API methods that don't need authentication
121 function requires_auth()
123 static $noauth = array( 'statuses/public_timeline',
127 'help/downtime_schedule',
138 static $bareauth = array('statuses/user_timeline',
139 'statuses/friends_timeline',
143 'statuses/followers',
144 'favorites/favorites',
146 'groups/list_groups');
148 $fullname = "$this->api_action/$this->api_method";
150 // If the site is "private", all API methods except statusnet/config
151 // need authentication
153 if (common_config('site', 'private')) {
154 return $fullname != 'statusnet/config' || false;
157 // bareauth: only needs auth if without an argument or query param specifying user
159 if (in_array($fullname, $bareauth)) {
161 // Special case: friendships/show only needs auth if source_id or
162 // source_screen_name is not specified as a param
164 if ($fullname == 'friendships/show') {
166 $source_id = $this->arg('source_id');
167 $source_screen_name = $this->arg('source_screen_name');
169 if (empty($source_id) && empty($source_screen_name)) {
176 // if all of these are empty, auth is required
178 $id = $this->arg('id');
179 $user_id = $this->arg('user_id');
180 $screen_name = $this->arg('screen_name');
182 if (empty($this->api_arg) &&
185 empty($screen_name)) {
191 } else if (in_array($fullname, $noauth)) {
193 // noauth: never needs auth
198 // everybody else needs auth
204 function show_basic_auth_error()
206 header('HTTP/1.1 401 Unauthorized');
207 $msg = 'Could not authenticate you.';
209 if ($this->content_type == 'xml') {
210 header('Content-Type: application/xml; charset=utf-8');
212 $this->elementStart('hash');
213 $this->element('error', null, $msg);
214 $this->element('request', null, $_SERVER['REQUEST_URI']);
215 $this->elementEnd('hash');
217 } else if ($this->content_type == 'json') {
218 header('Content-Type: application/json; charset=utf-8');
219 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
220 print(json_encode($error_array));
222 header('Content-type: text/plain');
227 function isReadOnly($args)
229 $apiaction = $args['apiaction'];
230 $method = $args['method'];
232 list($cmdtext, $fmt) = explode('.', $method);
234 static $write_methods = array(
235 'account' => array('update_location', 'update_delivery_device', 'end_session'),
236 'blocks' => array('create', 'destroy'),
237 'direct_messages' => array('create', 'destroy'),
238 'favorites' => array('create', 'destroy'),
239 'friendships' => array('create', 'destroy'),
241 'notifications' => array('follow', 'leave'),
242 'statuses' => array('update', 'destroy'),
246 if (array_key_exists($apiaction, $write_methods)) {
247 if (!in_array($cmdtext, $write_methods[$apiaction])) {