2 require_once("bbcode.php");
3 require_once("datetime.php");
14 function api_date($str){
15 //Wed May 23 06:01:13 +0000 2007
16 return datetime_convert('UTC', 'UTC', $str, "D M d h:i:s +0000 Y" );
20 function api_register_func($path, $func, $auth=false){
22 $API[$path] = array('func'=>$func,
29 function api_login(&$a){
30 // workaround for HTTP-auth in CGI mode
31 if(x($_SERVER,'REDIRECT_REMOTE_USER')) {
32 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"],6)) ;
33 if(strlen($userpass)) {
34 list($name, $password) = explode(':', $userpass);
35 $_SERVER['PHP_AUTH_USER'] = $name;
36 $_SERVER['PHP_AUTH_PW'] = $password;
40 if (!isset($_SERVER['PHP_AUTH_USER'])) {
41 logger('API_login: ' . print_r($_SERVER,true), LOGGER_DEBUG);
42 header('WWW-Authenticate: Basic realm="Friendika"');
43 header('HTTP/1.0 401 Unauthorized');
44 die('This api requires login');
47 $user = $_SERVER['PHP_AUTH_USER'];
48 $encrypted = hash('whirlpool',trim($_SERVER['PHP_AUTH_PW']));
52 * next code from mod/auth.php. needs better solution
55 // process normal login request
57 $r = q("SELECT * FROM `user` WHERE ( `email` = '%s' OR `nickname` = '%s' )
58 AND `password` = '%s' AND `blocked` = 0 AND `verified` = 1 LIMIT 1",
66 logger('API_login failure: ' . print_r($_SERVER,true), LOGGER_DEBUG);
67 header('WWW-Authenticate: Basic realm="Friendika"');
68 header('HTTP/1.0 401 Unauthorized');
69 die('This api requires login');
71 $_SESSION['uid'] = $record['uid'];
72 $_SESSION['theme'] = $record['theme'];
73 $_SESSION['authenticated'] = 1;
74 $_SESSION['page_flags'] = $record['page-flags'];
75 $_SESSION['my_url'] = $a->get_baseurl() . '/profile/' . $record['nickname'];
76 $_SESSION['addr'] = $_SERVER['REMOTE_ADDR'];
78 //notice( t("Welcome back ") . $record['username'] . EOL);
81 if(strlen($a->user['timezone'])) {
82 date_default_timezone_set($a->user['timezone']);
83 $a->timezone = $a->user['timezone'];
86 $r = q("SELECT * FROM `contact` WHERE `uid` = %s AND `self` = 1 LIMIT 1",
87 intval($_SESSION['uid']));
90 $a->cid = $r[0]['id'];
91 $_SESSION['cid'] = $a->cid;
93 q("UPDATE `user` SET `login_date` = '%s' WHERE `uid` = %d LIMIT 1",
94 dbesc(datetime_convert()),
95 intval($_SESSION['uid'])
98 call_hooks('logged_in', $a->user);
100 header('X-Account-Management-Status: active; name="' . $a->user['username'] . '"; id="' . $a->user['nickname'] .'"');
103 /**************************
104 * MAIN API ENTRY POINT *
105 **************************/
106 function api_call(&$a){
108 foreach ($API as $p=>$info){
109 if (strpos($a->query_string, $p)===0){
110 #unset($_SERVER['PHP_AUTH_USER']);
111 if ($info['auth']===true && local_user()===false) {
116 if (strpos($a->query_string, ".xml")>0) $type="xml";
117 if (strpos($a->query_string, ".json")>0) $type="json";
118 if (strpos($a->query_string, ".rss")>0) $type="rss";
119 if (strpos($a->query_string, ".atom")>0) $type="atom";
121 $r = call_user_func($info['func'], $a, $type);
122 if ($r===false) return;
126 $r = mb_convert_encoding($r, "UTF-8",mb_detect_encoding($r));
127 header ("Content-Type: text/xml");
128 return '<?xml version="1.0" encoding="UTF-8"?>'."\n".$r;
131 header ("Content-Type: application/json");
133 return json_encode($rr);
136 header ("Content-Type: application/rss+xml");
137 return '<?xml version="1.0" encoding="UTF-8"?>'."\n".$r;
140 #header ("Content-Type: application/atom+xml");
141 return '<?xml version="1.0" encoding="UTF-8"?>'."\n".$r;
145 //echo "<pre>"; var_dump($r); die();
154 function api_rss_extra(&$a, $arr, $user_info){
155 if (is_null($user_info)) $user_info = api_get_user($a);
156 $arr['$rss'] = array(
157 'alternate' => $user_info['url'],
158 'self' => $a->get_baseurl(). "/". $a->query_string,
159 'updated' => api_date(null),
160 'language' => $user_info['language'],
161 'logo' => $a->get_baseurl()."/images/friendika-32.png",
168 * Returns user info array.
170 function api_get_user(&$a){
173 if(x($_GET, 'user_id')) {
174 $user = intval($_GET['user_id']);
175 $extra_query = "AND `contact`.`id` = %d ";
177 if(x($_GET, 'screen_name')) {
178 $user = dbesc($_GET['screen_name']);
179 $extra_query = "AND `contact`.`nick` = '%s' ";
183 list($user, $null) = explode(".",$a->argv[3]);
184 if(is_numeric($user)){
185 $user = intval($user);
186 $extra_query = "AND `contact`.`id` = %d ";
188 $user = dbesc($user);
189 $extra_query = "AND `contact`.`nick` = '%s' ";
194 if (local_user()===false) {
195 api_login($a); return False;
197 $user = $_SESSION['uid'];
198 $extra_query = "AND `user`.`uid` = %d ";
205 $uinfo = q("SELECT *, `contact`.`id` as `cid` FROM `user`, `contact`
206 WHERE `user`.`uid`=`contact`.`uid` AND `contact`.`self`=1
210 if (count($uinfo)==0) {
214 // count public wall messages
215 $r = q("SELECT COUNT(`id`) as `count` FROM `item`
218 AND `allow_cid`='' AND `allow_gid`='' AND `deny_cid`='' AND `deny_gid`=''",
219 intval($uinfo[0]['uid'])
221 $countitms = $r[0]['count'];
224 $r = q("SELECT COUNT(`id`) as `count` FROM `contact`
226 AND `self`=0 AND `blocked`=0",
227 intval($uinfo[0]['uid'])
229 $countfriends = $r[0]['count'];
233 'id' => $uinfo[0]['cid'],
234 'name' => $uinfo[0]['username'],
235 'screen_name' => $uinfo[0]['nickname'],
236 'location' => $uinfo[0]['default-location'],
237 'profile_image_url' => $uinfo[0]['micro'],
238 'url' => $uinfo[0]['url'],
239 'protected' => false, #
240 'friends_count' => $countfriends,
241 'created_at' => api_date($uinfo[0]['created']),
242 'utc_offset' => 0, #XXX: fix me
243 'time_zone' => $uinfo[0]['timezone'],
244 'geo_enabled' => false,
245 'statuses_count' => $countitms, #XXX: fix me
246 'lang' => 'en', #XXX: fix me
248 'followers_count' => $countfriends, #XXX: fix me
249 'favourites_count' => 0,
250 'contributors_enabled' => false,
251 'follow_request_sent' => false,
252 'profile_background_color' => 'cfe8f6',
253 'profile_text_color' => '000000',
254 'profile_link_color' => 'FF8500',
255 'profile_sidebar_fill_color' =>'AD0066',
256 'profile_sidebar_border_color' => 'AD0066',
257 'profile_background_image_url' => '',
258 'profile_background_tile' => false,
259 'profile_use_background_image' => false,
260 'notifications' => false,
261 'verified' => true, #XXX: fix me
262 'followers' => '', #XXX: fix me
271 * apply xmlify() to all values of array $val, recursively
273 function api_xmlify($val){
274 if (is_bool($val)) return $val?"true":"false";
275 if (is_array($val)) return array_map('api_xmlify', $val);
280 * load api $templatename for $type and replace $data array
282 function api_apply_template($templatename, $type, $data){
288 $data = api_xmlify($data);
289 $tpl = get_markup_template("api_".$templatename."_".$type.".tpl");
290 $ret = replace_macros($tpl, $data);
304 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
305 * returns a 401 status code and an error message if not.
306 * http://developer.twitter.com/doc/get/account/verify_credentials
308 function api_account_verify_credentials(&$a, $type){
309 if (local_user()===false) return false;
310 $user_info = api_get_user($a);
312 return api_apply_template("user", $type, array('$user' => $user_info));
315 api_register_func('api/account/verify_credentials','api_account_verify_credentials', true);
318 // TODO - media uploads and alternate 'source'
320 function api_statuses_update(&$a, $type) {
321 if (local_user()===false) return false;
322 $user_info = api_get_user($a);
324 // convert $_POST array items to the form we use for web posts.
326 $_POST['body'] = urldecode($_POST['status']);
327 $_POST['parent'] = $_POST['in_reply_to_status_id'];
328 if($_POST['lat'] && $_POST['long'])
329 $_POST['coord'] = sprintf("%s %s",$_POST['lat'],$_POST['long']);
330 $_POST['profile_uid'] = local_user();
332 $_POST['type'] = 'net-comment';
334 $_POST['type'] = 'wall';
336 // set this so that the item_post() function is quiet and doesn't redirect or emit json
338 $_POST['api_source'] = true;
340 // call out normal post function
342 require_once('mod/item.php');
345 // this should output the last post (the one we just posted).
346 return api_status_show($a,$type);
348 api_register_func('api/statuses/update','api_statuses_update', true);
351 function api_status_show(&$a, $type){
352 $user_info = api_get_user($a);
353 // get last public wall message
354 $lastwall = q("SELECT `item`.*, `i`.`contact-id` as `reply_uid`, `i`.`nick` as `reply_author`
355 FROM `item`, `contact`,
356 (SELECT `item`.`id`, `item`.`contact-id`, `contact`.`nick` FROM `item`,`contact` WHERE `contact`.`id`=`item`.`contact-id`) as `i`
357 WHERE `item`.`contact-id` = %d
358 AND `i`.`id` = `item`.`parent`
359 AND `contact`.`id`=`item`.`contact-id` AND `contact`.`self`=1
360 AND `type`!='activity'
361 AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''
362 ORDER BY `created` DESC
364 intval($user_info['id'])
367 if (count($lastwall)>0){
368 $lastwall = $lastwall[0];
370 $in_reply_to_status_id = '';
371 $in_reply_to_user_id = '';
372 $in_reply_to_screen_name = '';
373 if ($lastwall['parent']!=$lastwall['id']) {
374 $in_reply_to_status_id=$lastwall['parent'];
375 $in_reply_to_user_id = $lastwall['reply_uid'];
376 $in_reply_to_screen_name = $lastwall['reply_author'];
378 $status_info = array(
379 'created_at' => api_date($lastwall['created']),
380 'id' => $lastwall['contact-id'],
381 'text' => strip_tags(bbcode($lastwall['body'])),
383 'truncated' => false,
384 'in_reply_to_status_id' => $in_reply_to_status_id,
385 'in_reply_to_user_id' => $in_reply_to_user_id,
386 'favorited' => false,
387 'in_reply_to_screen_name' => $in_reply_to_screen_name,
389 'coordinates' => $lastwall['coord'],
390 'place' => $lastwall['location'],
393 $status_info['user'] = $user_info;
395 return api_apply_template("status", $type, array('$status' => $status_info));
404 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
405 * The author's most recent status will be returned inline.
406 * http://developer.twitter.com/doc/get/users/show
408 function api_users_show(&$a, $type){
409 $user_info = api_get_user($a);
410 // get last public wall message
411 $lastwall = q("SELECT `item`.*, `i`.`contact-id` as `reply_uid`, `i`.`nick` as `reply_author`
412 FROM `item`, `contact`,
413 (SELECT `item`.`id`, `item`.`contact-id`, `contact`.`nick` FROM `item`,`contact` WHERE `contact`.`id`=`item`.`contact-id`) as `i`
414 WHERE `item`.`contact-id` = %d
415 AND `i`.`id` = `item`.`parent`
416 AND `contact`.`id`=`item`.`contact-id` AND `contact`.`self`=1
417 AND `type`!='activity'
418 AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''
419 ORDER BY `created` DESC
421 intval($user_info['id'])
424 if (count($lastwall)>0){
425 $lastwall = $lastwall[0];
427 $in_reply_to_status_id = '';
428 $in_reply_to_user_id = '';
429 $in_reply_to_screen_name = '';
430 if ($lastwall['parent']!=$lastwall['id']) {
431 $in_reply_to_status_id=$lastwall['parent'];
432 $in_reply_to_user_id = $lastwall['reply_uid'];
433 $in_reply_to_screen_name = $lastwall['reply_author'];
435 $user_info['status'] = array(
436 'created_at' => api_date($lastwall['created']),
437 'id' => $lastwall['contact-id'],
438 'text' => strip_tags(bbcode($lastwall['body'])),
440 'truncated' => false,
441 'in_reply_to_status_id' => $in_reply_to_status_id,
442 'in_reply_to_user_id' => $in_reply_to_user_id,
443 'favorited' => false,
444 'in_reply_to_screen_name' => $in_reply_to_screen_name,
446 'coordinates' => $lastwall['coord'],
447 'place' => $lastwall['location'],
451 return api_apply_template("user", $type, array('$user' => $user_info));
454 api_register_func('api/users/show','api_users_show');
458 * http://developer.twitter.com/doc/get/statuses/home_timeline
460 * TODO: Optional parameters
461 * TODO: Add reply info
463 function api_statuses_home_timeline(&$a, $type){
464 if (local_user()===false) return false;
466 $user_info = api_get_user($a);
468 // get last newtork messages
469 $sql_extra = " AND `item`.`parent` IN ( SELECT `parent` FROM `item` WHERE `id` = `parent` ) ";
471 $r = q("SELECT `item`.*, `item`.`id` AS `item_id`,
472 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
473 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
474 `contact`.`id` AS `cid`, `contact`.`uid` AS `contact-uid`
475 FROM `item`, `contact`, `user`
476 WHERE `item`.`contact-id` = %d AND `user`.`uid` = `item`.`uid`
477 AND `item`.`visible` = 1 AND `item`.`deleted` = 0
478 AND `contact`.`id` = `item`.`contact-id`
479 AND `contact`.`blocked` = 0 AND `contact`.`pending` = 0
481 ORDER BY `item`.`created` DESC LIMIT %d ,%d ",
482 intval($user_info['id']),
487 foreach($r as $item) {
489 'created_at'=> api_date($item['created']),
490 'published' => datetime_convert('UTC','UTC',$item['created'],ATOM_TIME),
491 'updated' => datetime_convert('UTC','UTC',$item['edited'],ATOM_TIME),
493 'text' => strip_tags(bbcode($item['body'])),
494 'html' => bbcode($item['body']),
496 'url' => ($item['plink']!=''?$item['plink']:$item['author-link']),
497 'truncated' => False,
498 'in_reply_to_status_id' => ($item['parent']!=$item['id']?$item['parent']:''),
499 'in_reply_to_user_id' => '',
500 'favorited' => false,
501 'in_reply_to_screen_name' => '',
503 'coordinates' => $item['coord'],
504 'place' => $item['location'],
505 'contributors' => '',
508 'user' => $user_info,
509 'objecttype' => $item['object-type'],
510 'verb' => $item['verb'],
511 'self' => $a->get_baseurl()."/api/statuses/show/".$ite['id'].".".$type,
512 'edit' => $a->get_baseurl()."/api/statuses/show/".$ite['id'].".".$type,
517 $data = array('$statuses' => $ret);
521 $data = api_rss_extra($a, $data, $user_info);
524 return api_apply_template("timeline", $type, $data);
526 api_register_func('api/statuses/home_timeline','api_statuses_home_timeline', true);
527 api_register_func('api/statuses/friends_timeline','api_statuses_home_timeline', true);
528 api_register_func('api/statuses/user_timeline','api_statuses_home_timeline', true);
529 # TODO: user_timeline should be profile view
532 function api_account_rate_limit_status(&$a,$type) {
535 'remaining_hits' => (string) 150,
536 'hourly_limit' => (string) 150,
537 'reset_time' => datetime_convert('UTC','UTC','now + 1 hour',ATOM_TIME),
538 'reset_time_in_seconds' => strtotime('now + 1 hour')
541 return api_apply_template('ratelimit', $type, array('$hash' => $hash));
544 api_register_func('api/account/rate_limit_status','api_account_rate_limit_status',true);