]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/api.php
Added the Autocomplete plugin
[quix0rs-gnu-social.git] / actions / api.php
1 <?php
2 /*
3  * Laconica - a distributed open-source microblogging tool
4  * Copyright (C) 2008, 2009, Control Yourself, Inc.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 if (!defined('LACONICA')) { exit(1); }
21
22 class ApiAction extends Action
23 {
24
25     var $user;
26     var $content_type;
27     var $api_arg;
28     var $api_method;
29     var $api_action;
30
31     function handle($args)
32     {
33         parent::handle($args);
34
35         $this->api_action = $this->arg('apiaction');
36         $method = $this->arg('method');
37         $argument = $this->arg('argument');
38
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]);
44         } else {
45
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]);
50         }
51
52         if ($this->requires_auth()) {
53             if (!isset($_SERVER['PHP_AUTH_USER'])) {
54
55                 # This header makes basic auth go
56                 header('WWW-Authenticate: Basic realm="Laconica API"');
57
58                 # If the user hits cancel -- bam!
59                 $this->show_basic_auth_error();
60             } else {
61                 $nickname = $_SERVER['PHP_AUTH_USER'];
62                 $password = $_SERVER['PHP_AUTH_PW'];
63                 $user = common_check_user($nickname, $password);
64
65                 if ($user) {
66                     $this->user = $user;
67                     $this->process_command();
68                 } else {
69                     # basic authentication failed
70                     list($proxy, $ip) = common_client_ip();
71
72                     common_log(LOG_WARNING, "Failed API auth attempt, nickname = $nickname, proxy = $proxy, ip = $ip.");
73                     $this->show_basic_auth_error();
74                 }
75             }
76         } else {
77
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']);
81                 if ($user) {
82                     $this->user = $user;
83                 }
84                 # Twitter doesn't throw an error if the user isn't found
85             }
86
87             $this->process_command();
88         }
89     }
90
91     function process_command()
92     {
93         $action = "twitapi$this->api_action";
94         $actionfile = INSTALLDIR."/actions/$action.php";
95
96         if (file_exists($actionfile)) {
97             require_once($actionfile);
98             $action_class = ucfirst($action)."Action";
99             $action_obj = new $action_class();
100
101             if (!$action_obj->prepare($this->args)) {
102                 return;
103             }
104
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);
110
111                 call_user_func(array($action_obj, $this->api_method), $_REQUEST, $apidata);
112             } else {
113                 $this->clientError("API method not found!", $code=404);
114             }
115         } else {
116             $this->clientError("API method not found!", $code=404);
117         }
118     }
119
120     // Whitelist of API methods that don't need authentication
121     function requires_auth()
122     {
123         static $noauth = array( 'statuses/public_timeline',
124                                 'statuses/show',
125                                 'users/show',
126                                 'help/test',
127                                 'help/downtime_schedule',
128                                 'laconica/version',
129                                 'laconica/config',
130                                 'laconica/wadl',
131                                 'tags/timeline',
132                                 'oembed/oembed',
133                                 'groups/show',
134                                 'groups/timeline');
135
136         static $bareauth = array('statuses/user_timeline',
137                                  'statuses/friends_timeline',
138                                  'statuses/friends',
139                                  'statuses/replies',
140                                  'statuses/mentions',
141                                  'statuses/followers',
142                                  'favorites/favorites',
143                                  'friendships/show');
144
145         $fullname = "$this->api_action/$this->api_method";
146
147         // If the site is "private", all API methods except laconica/config
148         // need authentication
149
150         if (common_config('site', 'private')) {
151             return $fullname != 'laconica/config' || false;
152         }
153
154         // bareauth: only needs auth if without an argument or query param specifying user
155
156         if (in_array($fullname, $bareauth)) {
157
158             // Special case: friendships/show only needs auth if source_id or
159             // source_screen_name is not specified as a param
160
161             if ($fullname == 'friendships/show') {
162
163                 $source_id          = $this->arg('source_id');
164                 $source_screen_name = $this->arg('source_screen_name');
165
166                 if (empty($source_id) && empty($source_screen_name)) {
167                     return true;
168                 }
169
170                 return false;
171             }
172
173             // if all of these are empty, auth is required
174
175             $id          = $this->arg('id');
176             $user_id     = $this->arg('user_id');
177             $screen_name = $this->arg('screen_name');
178
179             if (empty($this->api_arg) &&
180                 empty($id)            &&
181                 empty($user_id)       &&
182                 empty($screen_name)) {
183                 return true;
184             } else {
185                 return false;
186             }
187
188         } else if (in_array($fullname, $noauth)) {
189
190             // noauth: never needs auth
191
192             return false;
193         } else {
194
195             // everybody else needs auth
196
197             return true;
198         }
199     }
200
201     function show_basic_auth_error()
202     {
203         header('HTTP/1.1 401 Unauthorized');
204         $msg = 'Could not authenticate you.';
205
206         if ($this->content_type == 'xml') {
207             header('Content-Type: application/xml; charset=utf-8');
208             $this->startXML();
209             $this->elementStart('hash');
210             $this->element('error', null, $msg);
211             $this->element('request', null, $_SERVER['REQUEST_URI']);
212             $this->elementEnd('hash');
213             $this->endXML();
214         } else if ($this->content_type == 'json')  {
215             header('Content-Type: application/json; charset=utf-8');
216             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
217             print(json_encode($error_array));
218         } else {
219             header('Content-type: text/plain');
220             print "$msg\n";
221         }
222     }
223
224     function isReadOnly($args)
225     {
226         $apiaction = $args['apiaction'];
227         $method = $args['method'];
228
229         list($cmdtext, $fmt) = explode('.', $method);
230
231         static $write_methods = array(
232             'account' => array('update_location', 'update_delivery_device', 'end_session'),
233             'blocks' => array('create', 'destroy'),
234             'direct_messages' => array('create', 'destroy'),
235             'favorites' => array('create', 'destroy'),
236             'friendships' => array('create', 'destroy'),
237             'help' => array(),
238             'notifications' => array('follow', 'leave'),
239             'statuses' => array('update', 'destroy'),
240             'users' => array()
241         );
242
243         if (array_key_exists($apiaction, $write_methods)) {
244             if (!in_array($cmdtext, $write_methods[$apiaction])) {
245                 return true;
246             }
247         }
248
249         return false;
250     }
251 }