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 ApiAction extends Action {
30 function handle($args) {
31 parent::handle($args);
33 $this->api_action = $this->arg('apiaction');
34 $method = $this->arg('method');
35 $argument = $this->arg('argument');
37 if (isset($argument)) {
38 $cmdext = explode('.', $argument);
39 $this->api_arg = $cmdext[0];
40 $this->api_method = $method;
41 $this->content_type = strtolower($cmdext[1]);
43 #content type will be an extension on the method
44 $cmdext = explode('.', $method);
45 $this->api_method = $cmdext[0];
46 $this->content_type = strtolower($cmdext[1]);
49 # XXX Maybe check to see if the command actually exists first?
50 if($this->requires_auth()) {
51 if (!isset($_SERVER['PHP_AUTH_USER'])) {
53 # This header makes basic auth go
54 header('WWW-Authenticate: Basic realm="Laconica API"');
56 # if the user hits cancel -- bam!
57 $this->show_basic_auth_error();
59 $nickname = $_SERVER['PHP_AUTH_USER'];
60 $password = $_SERVER['PHP_AUTH_PW'];
61 $user = common_check_user($nickname, $password);
65 $this->process_command();
67 # basic authentication failed
68 $this->show_basic_auth_error();
72 $this->process_command();
76 function process_command() {
77 $action = "twitapi$this->api_action";
78 $actionfile = INSTALLDIR."/actions/$action.php";
79 if (file_exists($actionfile)) {
80 require_once($actionfile);
81 $action_class = ucfirst($action)."Action";
82 $action_obj = new $action_class();
84 if (method_exists($action_obj, $this->api_method)) {
86 $apidata = array( 'content-type' => $this->content_type,
87 'api_method' => $this->api_method,
88 'api_arg' => $this->api_arg,
89 'user' => $this->user);
91 call_user_func(array($action_obj, $this->api_method), $_REQUEST, $apidata);
92 # all API methods should exit()
95 common_user_error("API method not found!", $code=404);
99 # Whitelist of API methods that don't need authentication
100 function requires_auth() {
101 static $noauth = array( 'statuses/public_timeline',
105 'help/downtime_schedule');
107 static $bareauth = array('statuses/user_timeline',
109 'statuses/followers');
111 $fullname = "$this->api_action/$this->api_method";
113 if (in_array($fullname, $bareauth)) {
114 # bareauth: only needs auth if without an argument
115 if ($this->api_arg) {
120 } else if (in_array($fullname, $noauth)) {
121 # noauth: never needs auth
124 # everybody else needs auth
129 function show_basic_auth_error() {
130 header('HTTP/1.1 401 Unauthorized');
131 header('Content-type: text/plain');
132 print("Could not authenticate you."); # exactly what Twitter says - no \n