friendica_2021-01/include/api.php

545 lines
16 KiB
PHP
Raw Normal View History

2011-02-15 12:24:21 +01:00
<?php
require_once("bbcode.php");
require_once("datetime.php");
/*
* Twitter-Like API
*
*/
$API = Array();
2011-04-21 17:03:31 +02:00
2011-02-15 12:24:21 +01:00
function api_date($str){
//Wed May 23 06:01:13 +0000 2007
return datetime_convert('UTC', 'UTC', $str, "D M d h:i:s +0000 Y" );
}
function api_register_func($path, $func, $auth=false){
global $API;
$API[$path] = array('func'=>$func,
2011-02-16 08:56:47 +01:00
'auth'=>$auth);
2011-02-15 12:24:21 +01:00
}
/**
* Simple HTTP Login
*/
function api_login(&$a){
// workaround for HTTP-auth in CGI mode
if(x($_SERVER,'REDIRECT_REMOTE_USER')) {
$userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"],6)) ;
if(strlen($userpass)) {
list($name, $password) = explode(':', $userpass);
$_SERVER['PHP_AUTH_USER'] = $name;
$_SERVER['PHP_AUTH_PW'] = $password;
}
}
2011-02-15 12:24:21 +01:00
if (!isset($_SERVER['PHP_AUTH_USER'])) {
logger('API_login: ' . print_r($_SERVER,true), LOGGER_DEBUG);
2011-02-15 12:24:21 +01:00
header('WWW-Authenticate: Basic realm="Friendika"');
header('HTTP/1.0 401 Unauthorized');
die('This api requires login');
2011-02-15 12:24:21 +01:00
}
$user = $_SERVER['PHP_AUTH_USER'];
$encrypted = hash('whirlpool',trim($_SERVER['PHP_AUTH_PW']));
2011-04-21 17:03:31 +02:00
/**
* next code from mod/auth.php. needs better solution
*/
2011-02-15 12:24:21 +01:00
// process normal login request
$r = q("SELECT * FROM `user` WHERE ( `email` = '%s' OR `nickname` = '%s' )
AND `password` = '%s' AND `blocked` = 0 AND `verified` = 1 LIMIT 1",
dbesc(trim($user)),
dbesc(trim($user)),
dbesc($encrypted)
);
2011-04-27 17:46:23 +02:00
if(count($r)){
2011-02-15 12:24:21 +01:00
$record = $r[0];
2011-04-27 17:46:23 +02:00
} else {
logger('API_login failure: ' . print_r($_SERVER,true), LOGGER_DEBUG);
2011-04-27 17:46:23 +02:00
header('WWW-Authenticate: Basic realm="Friendika"');
header('HTTP/1.0 401 Unauthorized');
die('This api requires login');
2011-04-27 17:46:23 +02:00
}
2011-02-15 12:24:21 +01:00
$_SESSION['uid'] = $record['uid'];
$_SESSION['theme'] = $record['theme'];
$_SESSION['authenticated'] = 1;
$_SESSION['page_flags'] = $record['page-flags'];
$_SESSION['my_url'] = $a->get_baseurl() . '/profile/' . $record['nickname'];
$_SESSION['addr'] = $_SERVER['REMOTE_ADDR'];
2011-04-21 17:03:31 +02:00
//notice( t("Welcome back ") . $record['username'] . EOL);
2011-02-15 12:24:21 +01:00
$a->user = $record;
if(strlen($a->user['timezone'])) {
date_default_timezone_set($a->user['timezone']);
$a->timezone = $a->user['timezone'];
}
$r = q("SELECT * FROM `contact` WHERE `uid` = %s AND `self` = 1 LIMIT 1",
intval($_SESSION['uid']));
if(count($r)) {
$a->contact = $r[0];
$a->cid = $r[0]['id'];
$_SESSION['cid'] = $a->cid;
}
q("UPDATE `user` SET `login_date` = '%s' WHERE `uid` = %d LIMIT 1",
dbesc(datetime_convert()),
intval($_SESSION['uid'])
);
call_hooks('logged_in', $a->user);
header('X-Account-Management-Status: active; name="' . $a->user['username'] . '"; id="' . $a->user['nickname'] .'"');
}
2011-04-21 17:03:31 +02:00
/**************************
* MAIN API ENTRY POINT *
**************************/
2011-02-15 12:24:21 +01:00
function api_call(&$a){
GLOBAL $API;
foreach ($API as $p=>$info){
if (strpos($a->query_string, $p)===0){
2011-04-27 17:46:23 +02:00
#unset($_SERVER['PHP_AUTH_USER']);
2011-04-21 17:03:31 +02:00
if ($info['auth']===true && local_user()===false) {
api_login($a);
2011-02-15 12:24:21 +01:00
}
2011-04-21 17:03:31 +02:00
$type="json";
if (strpos($a->query_string, ".xml")>0) $type="xml";
if (strpos($a->query_string, ".json")>0) $type="json";
if (strpos($a->query_string, ".rss")>0) $type="rss";
if (strpos($a->query_string, ".atom")>0) $type="atom";
2011-02-15 12:24:21 +01:00
2011-04-21 17:03:31 +02:00
$r = call_user_func($info['func'], $a, $type);
if ($r===false) return;
switch($type){
case "xml":
$r = mb_convert_encoding($r, "UTF-8",mb_detect_encoding($r));
header ("Content-Type: text/xml");
return '<?xml version="1.0" encoding="UTF-8"?>'."\n".$r;
break;
case "json":
header ("Content-Type: application/json");
2011-06-21 02:16:13 +02:00
foreach($r as $rr)
return json_encode($rr);
2011-04-21 17:03:31 +02:00
break;
case "rss":
header ("Content-Type: application/rss+xml");
return '<?xml version="1.0" encoding="UTF-8"?>'."\n".$r;
break;
case "atom":
#header ("Content-Type: application/atom+xml");
return '<?xml version="1.0" encoding="UTF-8"?>'."\n".$r;
break;
2011-02-15 12:24:21 +01:00
}
//echo "<pre>"; var_dump($r); die();
}
}
return false;
}
2011-04-21 17:03:31 +02:00
/**
* RSS extra info
*/
function api_rss_extra(&$a, $arr, $user_info){
if (is_null($user_info)) $user_info = api_get_user($a);
$arr['$rss'] = array(
'alternate' => $user_info['url'],
'self' => $a->get_baseurl(). "/". $a->query_string,
'updated' => api_date(null),
'language' => $user_info['language'],
2011-04-27 17:46:23 +02:00
'logo' => $a->get_baseurl()."/images/friendika-32.png",
2011-04-21 17:03:31 +02:00
);
return $arr;
}
2011-02-15 12:24:21 +01:00
/**
2011-04-21 17:03:31 +02:00
* Returns user info array.
2011-02-15 12:24:21 +01:00
*/
2011-02-16 08:56:47 +01:00
function api_get_user(&$a){
2011-02-15 12:24:21 +01:00
$user = null;
$extra_query = "";
if(x($_GET, 'user_id')) {
$user = intval($_GET['user_id']);
2011-04-21 17:03:31 +02:00
$extra_query = "AND `contact`.`id` = %d ";
2011-02-15 12:24:21 +01:00
}
if(x($_GET, 'screen_name')) {
$user = dbesc($_GET['screen_name']);
2011-04-21 17:03:31 +02:00
$extra_query = "AND `contact`.`nick` = '%s' ";
2011-02-15 12:24:21 +01:00
}
if ($user===null){
list($user, $null) = explode(".",$a->argv[3]);
if(is_numeric($user)){
$user = intval($user);
2011-04-21 17:03:31 +02:00
$extra_query = "AND `contact`.`id` = %d ";
2011-02-15 12:24:21 +01:00
} else {
$user = dbesc($user);
2011-04-21 17:03:31 +02:00
$extra_query = "AND `contact`.`nick` = '%s' ";
2011-02-15 12:24:21 +01:00
}
}
if ($user==='') {
2011-02-16 08:56:47 +01:00
if (local_user()===false) {
api_login($a); return False;
} else {
$user = $_SESSION['uid'];
$extra_query = "AND `user`.`uid` = %d ";
}
2011-02-15 12:24:21 +01:00
}
// user info
2011-04-21 17:03:31 +02:00
$uinfo = q("SELECT *, `contact`.`id` as `cid` FROM `user`, `contact`
2011-02-15 12:24:21 +01:00
WHERE `user`.`uid`=`contact`.`uid` AND `contact`.`self`=1
$extra_query",
$user
);
if (count($uinfo)==0) {
return False;
}
// count public wall messages
$r = q("SELECT COUNT(`id`) as `count` FROM `item`
WHERE `uid` = %d
AND `type`='wall'
AND `allow_cid`='' AND `allow_gid`='' AND `deny_cid`='' AND `deny_gid`=''",
intval($uinfo[0]['uid'])
);
$countitms = $r[0]['count'];
// count friends
$r = q("SELECT COUNT(`id`) as `count` FROM `contact`
WHERE `uid` = %d
AND `self`=0 AND `blocked`=0",
intval($uinfo[0]['uid'])
);
$countfriends = $r[0]['count'];
2011-02-16 08:56:47 +01:00
$ret = Array(
2011-04-21 17:03:31 +02:00
'id' => $uinfo[0]['cid'],
2011-02-16 08:56:47 +01:00
'name' => $uinfo[0]['username'],
'screen_name' => $uinfo[0]['nickname'],
'location' => $uinfo[0]['default-location'],
2011-04-27 17:46:23 +02:00
'profile_image_url' => $uinfo[0]['micro'],
2011-02-16 08:56:47 +01:00
'url' => $uinfo[0]['url'],
'protected' => false, #
'friends_count' => $countfriends,
'created_at' => api_date($uinfo[0]['created']),
'utc_offset' => 0, #XXX: fix me
'time_zone' => $uinfo[0]['timezone'],
'geo_enabled' => false,
'statuses_count' => $countitms, #XXX: fix me
'lang' => 'en', #XXX: fix me
'description' => '',
'followers_count' => $countfriends, #XXX: fix me
'favourites_count' => 0,
'contributors_enabled' => false,
'follow_request_sent' => false,
'profile_background_color' => 'cfe8f6',
'profile_text_color' => '000000',
'profile_link_color' => 'FF8500',
'profile_sidebar_fill_color' =>'AD0066',
'profile_sidebar_border_color' => 'AD0066',
'profile_background_image_url' => '',
'profile_background_tile' => false,
'profile_use_background_image' => false,
2011-04-21 17:03:31 +02:00
'notifications' => false,
'verified' => true, #XXX: fix me
'followers' => '', #XXX: fix me
#'status' => null
2011-02-16 08:56:47 +01:00
);
2011-04-21 17:03:31 +02:00
2011-02-16 08:56:47 +01:00
return $ret;
}
2011-04-21 17:03:31 +02:00
/**
* apply xmlify() to all values of array $val, recursively
*/
function api_xmlify($val){
if (is_bool($val)) return $val?"true":"false";
if (is_array($val)) return array_map('api_xmlify', $val);
return xmlify($val);
}
/**
* load api $templatename for $type and replace $data array
*/
function api_apply_template($templatename, $type, $data){
2011-06-21 02:16:13 +02:00
2011-04-21 17:03:31 +02:00
switch($type){
case "rss":
case "atom":
case "xml":
$data = api_xmlify($data);
2011-05-11 13:37:13 +02:00
$tpl = get_markup_template("api_".$templatename."_".$type.".tpl");
2011-04-21 17:03:31 +02:00
$ret = replace_macros($tpl, $data);
break;
case "json":
$ret = $data;
break;
}
return $ret;
}
2011-02-16 08:56:47 +01:00
/**
** TWITTER API
*/
/**
* Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
* returns a 401 status code and an error message if not.
* http://developer.twitter.com/doc/get/account/verify_credentials
*/
2011-04-21 17:03:31 +02:00
function api_account_verify_credentials(&$a, $type){
2011-02-16 08:56:47 +01:00
if (local_user()===false) return false;
$user_info = api_get_user($a);
2011-04-21 17:03:31 +02:00
return api_apply_template("user", $type, array('$user' => $user_info));
2011-02-16 08:56:47 +01:00
}
api_register_func('api/account/verify_credentials','api_account_verify_credentials', true);
// TODO - media uploads and alternate 'source'
2011-02-16 08:56:47 +01:00
function api_statuses_update(&$a, $type) {
if (local_user()===false) return false;
$user_info = api_get_user($a);
// convert $_POST array items to the form we use for web posts.
$_POST['body'] = urldecode($_POST['status']);
$_POST['parent'] = $_POST['in_reply_to_status_id'];
if($_POST['lat'] && $_POST['long'])
$_POST['coord'] = sprintf("%s %s",$_POST['lat'],$_POST['long']);
$_POST['profile_uid'] = local_user();
if($_POST['parent'])
$_POST['type'] = 'net-comment';
else
$_POST['type'] = 'wall';
// set this so that the item_post() function is quiet and doesn't redirect or emit json
$_POST['api_source'] = true;
// call out normal post function
require_once('mod/item.php');
item_post($a);
// this should output the last post (the one we just posted).
return api_status_show($a,$type);
}
api_register_func('api/statuses/update','api_statuses_update', true);
function api_status_show(&$a, $type){
$user_info = api_get_user($a);
// get last public wall message
$lastwall = q("SELECT `item`.*, `i`.`contact-id` as `reply_uid`, `i`.`nick` as `reply_author`
FROM `item`, `contact`,
(SELECT `item`.`id`, `item`.`contact-id`, `contact`.`nick` FROM `item`,`contact` WHERE `contact`.`id`=`item`.`contact-id`) as `i`
WHERE `item`.`contact-id` = %d
AND `i`.`id` = `item`.`parent`
AND `contact`.`id`=`item`.`contact-id` AND `contact`.`self`=1
AND `type`!='activity'
AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''
ORDER BY `created` DESC
LIMIT 1",
intval($user_info['id'])
);
if (count($lastwall)>0){
$lastwall = $lastwall[0];
$in_reply_to_status_id = '';
$in_reply_to_user_id = '';
$in_reply_to_screen_name = '';
if ($lastwall['parent']!=$lastwall['id']) {
$in_reply_to_status_id=$lastwall['parent'];
$in_reply_to_user_id = $lastwall['reply_uid'];
$in_reply_to_screen_name = $lastwall['reply_author'];
}
$status_info = array(
'created_at' => api_date($lastwall['created']),
'id' => $lastwall['contact-id'],
'text' => strip_tags(bbcode($lastwall['body'])),
'source' => 'web',
'truncated' => false,
'in_reply_to_status_id' => $in_reply_to_status_id,
'in_reply_to_user_id' => $in_reply_to_user_id,
'favorited' => false,
'in_reply_to_screen_name' => $in_reply_to_screen_name,
'geo' => '',
'coordinates' => $lastwall['coord'],
'place' => $lastwall['location'],
'contributors' => ''
);
$status_info['user'] = $user_info;
}
return api_apply_template("status", $type, array('$status' => $status_info));
}
2011-02-16 08:56:47 +01:00
/**
* Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
* The author's most recent status will be returned inline.
* http://developer.twitter.com/doc/get/users/show
*/
2011-04-21 17:03:31 +02:00
function api_users_show(&$a, $type){
2011-02-16 08:56:47 +01:00
$user_info = api_get_user($a);
2011-02-15 12:24:21 +01:00
// get last public wall message
2011-04-21 17:03:31 +02:00
$lastwall = q("SELECT `item`.*, `i`.`contact-id` as `reply_uid`, `i`.`nick` as `reply_author`
FROM `item`, `contact`,
(SELECT `item`.`id`, `item`.`contact-id`, `contact`.`nick` FROM `item`,`contact` WHERE `contact`.`id`=`item`.`contact-id`) as `i`
WHERE `item`.`contact-id` = %d
AND `i`.`id` = `item`.`parent`
AND `contact`.`id`=`item`.`contact-id` AND `contact`.`self`=1
AND `type`!='activity'
AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''
ORDER BY `created` DESC
LIMIT 1",
intval($user_info['id'])
2011-02-15 12:24:21 +01:00
);
2011-02-16 08:56:47 +01:00
2011-04-21 17:03:31 +02:00
if (count($lastwall)>0){
$lastwall = $lastwall[0];
$in_reply_to_status_id = '';
$in_reply_to_user_id = '';
$in_reply_to_screen_name = '';
if ($lastwall['parent']!=$lastwall['id']) {
$in_reply_to_status_id=$lastwall['parent'];
$in_reply_to_user_id = $lastwall['reply_uid'];
$in_reply_to_screen_name = $lastwall['reply_author'];
}
$user_info['status'] = array(
'created_at' => api_date($lastwall['created']),
'id' => $lastwall['contact-id'],
'text' => strip_tags(bbcode($lastwall['body'])),
'source' => 'web',
'truncated' => false,
'in_reply_to_status_id' => $in_reply_to_status_id,
'in_reply_to_user_id' => $in_reply_to_user_id,
'favorited' => false,
'in_reply_to_screen_name' => $in_reply_to_screen_name,
'geo' => '',
'coordinates' => $lastwall['coord'],
'place' => $lastwall['location'],
'contributors' => ''
);
}
return api_apply_template("user", $type, array('$user' => $user_info));
2011-02-15 12:24:21 +01:00
}
api_register_func('api/users/show','api_users_show');
/**
*
* http://developer.twitter.com/doc/get/statuses/home_timeline
2011-04-21 17:03:31 +02:00
*
* TODO: Optional parameters
* TODO: Add reply info
2011-02-15 12:24:21 +01:00
*/
2011-04-21 17:03:31 +02:00
function api_statuses_home_timeline(&$a, $type){
2011-02-15 12:24:21 +01:00
if (local_user()===false) return false;
2011-02-16 08:56:47 +01:00
$user_info = api_get_user($a);
2011-02-15 12:24:21 +01:00
// get last newtork messages
$sql_extra = " AND `item`.`parent` IN ( SELECT `parent` FROM `item` WHERE `id` = `parent` ) ";
2011-04-21 17:03:31 +02:00
2011-02-15 12:24:21 +01:00
$r = q("SELECT `item`.*, `item`.`id` AS `item_id`,
`contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
`contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
`contact`.`id` AS `cid`, `contact`.`uid` AS `contact-uid`
FROM `item`, `contact`, `user`
2011-04-21 17:03:31 +02:00
WHERE `item`.`contact-id` = %d AND `user`.`uid` = `item`.`uid`
2011-02-15 12:24:21 +01:00
AND `item`.`visible` = 1 AND `item`.`deleted` = 0
AND `contact`.`id` = `item`.`contact-id`
AND `contact`.`blocked` = 0 AND `contact`.`pending` = 0
$sql_extra
ORDER BY `item`.`created` DESC LIMIT %d ,%d ",
2011-02-16 08:56:47 +01:00
intval($user_info['id']),
0,20
2011-02-15 12:24:21 +01:00
);
2011-04-21 17:03:31 +02:00
$ret = Array();
2011-02-15 12:24:21 +01:00
2011-02-16 08:56:47 +01:00
foreach($r as $item) {
2011-04-21 17:03:31 +02:00
$status = array(
2011-02-15 12:24:21 +01:00
'created_at'=> api_date($item['created']),
2011-06-20 10:38:26 +02:00
'published' => datetime_convert('UTC','UTC',$item['created'],ATOM_TIME),
'updated' => datetime_convert('UTC','UTC',$item['edited'],ATOM_TIME),
2011-02-15 12:24:21 +01:00
'id' => $item['id'],
2011-02-16 08:56:47 +01:00
'text' => strip_tags(bbcode($item['body'])),
2011-04-27 17:46:23 +02:00
'html' => bbcode($item['body']),
2011-04-21 17:03:31 +02:00
'source' => 'web',
'url' => ($item['plink']!=''?$item['plink']:$item['author-link']),
2011-02-15 12:24:21 +01:00
'truncated' => False,
'in_reply_to_status_id' => ($item['parent']!=$item['id']?$item['parent']:''),
2011-02-15 12:24:21 +01:00
'in_reply_to_user_id' => '',
'favorited' => false,
'in_reply_to_screen_name' => '',
'geo' => '',
'coordinates' => $item['coord'],
'place' => $item['location'],
'contributors' => '',
'annotations' => '',
'entities' => '',
2011-04-27 17:46:23 +02:00
'user' => $user_info,
'objecttype' => $item['object-type'],
'verb' => $item['verb'],
'self' => $a->get_baseurl()."/api/statuses/show/".$ite['id'].".".$type,
'edit' => $a->get_baseurl()."/api/statuses/show/".$ite['id'].".".$type,
2011-04-21 17:03:31 +02:00
);
2011-02-15 12:24:21 +01:00
$ret[]=$status;
};
2011-04-21 17:03:31 +02:00
$data = array('$statuses' => $ret);
2011-04-27 17:46:23 +02:00
switch($type){
case "atom":
case "rss":
$data = api_rss_extra($a, $data, $user_info);
}
2011-04-21 17:03:31 +02:00
return api_apply_template("timeline", $type, $data);
2011-02-16 08:56:47 +01:00
}
2011-04-21 17:03:31 +02:00
api_register_func('api/statuses/home_timeline','api_statuses_home_timeline', true);
api_register_func('api/statuses/friends_timeline','api_statuses_home_timeline', true);
api_register_func('api/statuses/user_timeline','api_statuses_home_timeline', true);
# TODO: user_timeline should be profile view
2011-04-27 17:46:23 +02:00
2011-06-21 02:16:13 +02:00
function api_account_rate_limit_status(&$a,$type) {
$hash = array(
'remaining_hits' => (string) 150,
'hourly_limit' => (string) 150,
'reset_time' => datetime_convert('UTC','UTC','now + 1 hour',ATOM_TIME),
'reset_time_in_seconds' => strtotime('now + 1 hour')
);
return api_apply_template('ratelimit', $type, array('$hash' => $hash));
}
api_register_func('api/account/rate_limit_status','api_account_rate_limit_status',true);