bitPickups/friendica_2019-12_sharedHosting_hotFix
1
1
Fork 0
Code Pull requests Activity

Merge pull request #6797 from MrPetovan/task/improve-api-show-status

Browse source 
[API] Improve show status
This commit is contained in:
Philipp 2019-03-24 01:00:33 +01:00 committed by GitHub
parent 3a79c1c486 fb13d0c31b
commit 5dca91ee5a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 193 additions and 250 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

414
include/api.php
View file

@ -932,7 +932,6 @@ function api_format_data($root_element, $type, $data)
*/ */
function api_account_verify_credentials($type) function api_account_verify_credentials($type)
{ {
$a = \get_app(); $a = \get_app();
if (api_user() === false) { if (api_user() === false) {
@ -954,13 +953,9 @@ function api_account_verify_credentials($type)
// - Adding last status // - Adding last status
if (!$skip_status) { if (!$skip_status) {
$user_info["status"] = api_status_show("raw"); $item = api_get_last_status($user_info['pid'], $user_info['uid']);
if (isset($user_info["status"])) { if ($item) {
if (!is_array($user_info["status"]) || !count($user_info["status"])) { $user_info['status'] = api_format_item($item, $type);
unset($user_info["status"]);
} else {
unset($user_info["status"]["user"]);
}
} }
} }
@ -1244,105 +1239,61 @@ function api_media_upload()
api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST); api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
/** /**
* * @param string $type Return format (atom, rss, xml, json)
* @param string $type Return type (atom, rss, xml, json)
*
* @param int $item_id * @param int $item_id
* @return array|string * @return string
* @throws BadRequestException * @throws Exception
* @throws ImagickException
* @throws InternalServerErrorException
* @throws UnauthorizedException
*/ */
function api_status_show($type, $item_id = 0) function api_status_show($type, $item_id)
{ {
$a = \get_app(); Logger::info(API_LOG_PREFIX . 'Start', ['action' => 'status_show', 'type' => $type, 'item_id' => $item_id]);
$user_info = api_get_user($a); $status_info = [];
Logger::log('api_status_show: user_info: '.print_r($user_info, true), Logger::DEBUG); $item = api_get_item(['id' => $item_id]);
if ($item) {
if (!empty($item_id)) { $status_info = api_format_item($item, $type);
// Get the item with the given id
$condition = ['id' => $item_id];
} else {
// get last public wall message
$condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]];
} }
if ($type == "raw") { Logger::info(API_LOG_PREFIX . 'End', ['action' => 'get_status', 'status_info' => $status_info]);
$condition['private'] = false;
}
$lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]); return api_format_data('statuses', $type, ['status' => $status_info]);
}
if (DBA::isResult($lastwall)) { /**
$in_reply_to = api_in_reply_to($lastwall); * Retrieves the last public status of the provided user info
*
* @param int $ownerId Public contact Id
* @param int $uid User Id
* @return array
* @throws Exception
*/
function api_get_last_status($ownerId, $uid)
{
$condition = [
'owner-id' => $ownerId,
'uid' => $uid,
'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT],
'private' => false
];
$converted = api_convert_item($lastwall); $item = api_get_item($condition);
if ($type == "xml") { return $item;
$geo = "georss:point"; }
} else {
$geo = "geo";
}
$status_info = [ /**
'created_at' => api_date($lastwall['created']), * Retrieves a single item record based on the provided condition and converts it for API use.
'id' => intval($lastwall['id']), *
'id_str' => (string) $lastwall['id'], * @param array $condition Item table condition array
'text' => $converted["text"], * @return array
'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'), * @throws Exception
'truncated' => false, */
'in_reply_to_status_id' => $in_reply_to['status_id'], function api_get_item(array $condition)
'in_reply_to_status_id_str' => $in_reply_to['status_id_str'], {
'in_reply_to_user_id' => $in_reply_to['user_id'], $item = Item::selectFirst(Item::DISPLAY_FIELDLIST, $condition, ['order' => ['id' => true]]);
'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
'in_reply_to_screen_name' => $in_reply_to['screen_name'],
'user' => $user_info,
$geo => null,
'coordinates' => '',
'place' => '',
'contributors' => '',
'is_quote_status' => false,
'retweet_count' => 0,
'favorite_count' => 0,
'favorited' => $lastwall['starred'] ? true : false,
'retweeted' => false,
'possibly_sensitive' => false,
'lang' => '',
'statusnet_html' => $converted["html"],
'statusnet_conversation_id' => $lastwall['parent'],
'external_url' => System::baseUrl() . '/display/' . $lastwall['guid'],
];
if (count($converted["attachments"]) > 0) { return $item;
$status_info["attachments"] = $converted["attachments"];
}
if (count($converted["entities"]) > 0) {
$status_info["entities"] = $converted["entities"];
}
if ($status_info["source"] == 'web') {
$status_info["source"] = ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']);
} elseif (ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']) != $status_info["source"]) {
$status_info["source"] = trim($status_info["source"].' ('.ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']).')');
}
// "uid" and "self" are only needed for some internal stuff, so remove it from here
unset($status_info["user"]["uid"]);
unset($status_info["user"]["self"]);
Logger::log('status_info: '.print_r($status_info, true), Logger::DEBUG);
if ($type == "raw") {
return $status_info;
}
return api_format_data("statuses", $type, ['status' => $status_info]);
}
} }
/** /**
@ -1359,66 +1310,20 @@ function api_status_show($type, $item_id = 0)
*/ */
function api_users_show($type) function api_users_show($type)
{ {
$a = \get_app(); $a = \Friendica\BaseObject::getApp();
$user_info = api_get_user($a); $user_info = api_get_user($a);
$condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(), $item = api_get_last_status($user_info['pid'], $user_info['uid']);
'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'private' => false]; if ($item) {
$lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]); $user_info['status'] = api_format_item($item, $type);
if (DBA::isResult($lastwall)) {
$in_reply_to = api_in_reply_to($lastwall);
$converted = api_convert_item($lastwall);
if ($type == "xml") {
$geo = "georss:point";
} else {
$geo = "geo";
}
$user_info['status'] = [
'text' => $converted["text"],
'truncated' => false,
'created_at' => api_date($lastwall['created']),
'in_reply_to_status_id' => $in_reply_to['status_id'],
'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
'id' => intval($lastwall['contact-id']),
'id_str' => (string) $lastwall['contact-id'],
'in_reply_to_user_id' => $in_reply_to['user_id'],
'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
'in_reply_to_screen_name' => $in_reply_to['screen_name'],
$geo => null,
'favorited' => $lastwall['starred'] ? true : false,
'statusnet_html' => $converted["html"],
'statusnet_conversation_id' => $lastwall['parent'],
'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
];
if (count($converted["attachments"]) > 0) {
$user_info["status"]["attachments"] = $converted["attachments"];
}
if (count($converted["entities"]) > 0) {
$user_info["status"]["entities"] = $converted["entities"];
}
if ($user_info["status"]["source"] == 'web') {
$user_info["status"]["source"] = ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']);
}
if (ContactSelector::networkToName($lastwall['network'], $user_info['url']) != $user_info["status"]["source"]) {
$user_info["status"]["source"] = trim($user_info["status"]["source"] . ' (' . ContactSelector::networkToName($lastwall['network'], $lastwall['author-link']) . ')');
}
} }
// "uid" and "self" are only needed for some internal stuff, so remove it from here // "uid" and "self" are only needed for some internal stuff, so remove it from here
unset($user_info["uid"]); unset($user_info['uid']);
unset($user_info["self"]); unset($user_info['self']);
return api_format_data("user", $type, ['user' => $user_info]); return api_format_data('user', $type, ['user' => $user_info]);
} }
/// @TODO move to top of file or somewhere better /// @TODO move to top of file or somewhere better
@ -2972,7 +2877,7 @@ function api_format_items_profiles($profile_row)
/** /**
* @brief format items to be returned by api * @brief format items to be returned by api
* *
* @param array $r array of items * @param array $items array of items
* @param array $user_info * @param array $user_info
* @param bool $filter_user filter items by $user_info * @param bool $filter_user filter items by $user_info
* @param string $type Return type (atom, rss, xml, json) * @param string $type Return type (atom, rss, xml, json)
@ -2982,14 +2887,13 @@ function api_format_items_profiles($profile_row)
* @throws InternalServerErrorException * @throws InternalServerErrorException
* @throws UnauthorizedException * @throws UnauthorizedException
*/ */
function api_format_items($r, $user_info, $filter_user = false, $type = "json") function api_format_items($items, $user_info, $filter_user = false, $type = "json")
{ {
$a = \get_app(); $a = \Friendica\BaseObject::getApp();
$ret = []; $ret = [];
foreach ((array)$r as $item) { foreach ((array)$items as $item) {
localize_item($item);
list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item); list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
// Look if the posts are matching if they should be filtered by user id // Look if the posts are matching if they should be filtered by user id
@ -2997,100 +2901,128 @@ function api_format_items($r, $user_info, $filter_user = false, $type = "json")
continue; continue;
} }
$in_reply_to = api_in_reply_to($item); $status = api_format_item($item, $type, $status_user, $author_user, $owner_user);
$converted = api_convert_item($item);
if ($type == "xml") {
$geo = "georss:point";
} else {
$geo = "geo";
}
$status = [
'text' => $converted["text"],
'truncated' => false,
'created_at'=> api_date($item['created']),
'in_reply_to_status_id' => $in_reply_to['status_id'],
'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
'source' => (($item['app']) ? $item['app'] : 'web'),
'id' => intval($item['id']),
'id_str' => (string) intval($item['id']),
'in_reply_to_user_id' => $in_reply_to['user_id'],
'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
'in_reply_to_screen_name' => $in_reply_to['screen_name'],
$geo => null,
'favorited' => $item['starred'] ? true : false,
'user' => $status_user,
'friendica_author' => $author_user,
'friendica_owner' => $owner_user,
'friendica_private' => $item['private'] == 1,
//'entities' => NULL,
'statusnet_html' => $converted["html"],
'statusnet_conversation_id' => $item['parent'],
'external_url' => System::baseUrl() . "/display/" . $item['guid'],
'friendica_activities' => api_format_items_activities($item, $type),
];
if (count($converted["attachments"]) > 0) {
$status["attachments"] = $converted["attachments"];
}
if (count($converted["entities"]) > 0) {
$status["entities"] = $converted["entities"];
}
if ($status["source"] == 'web') {
$status["source"] = ContactSelector::networkToName($item['network'], $item['author-link']);
} elseif (ContactSelector::networkToName($item['network'], $item['author-link']) != $status["source"]) {
$status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['network'], $item['author-link']).')');
}
if ($item["id"] == $item["parent"]) {
$retweeted_item = api_share_as_retweet($item);
if ($retweeted_item !== false) {
$retweeted_status = $status;
$status['user'] = $status['friendica_owner'];
try {
$retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
} catch (BadRequestException $e) {
// user not found. should be found?
/// @todo check if the user should be always found
$retweeted_status["user"] = [];
}
$rt_converted = api_convert_item($retweeted_item);
$retweeted_status['text'] = $rt_converted["text"];
$retweeted_status['statusnet_html'] = $rt_converted["html"];
$retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
$retweeted_status['created_at'] = api_date($retweeted_item['created']);
$status['retweeted_status'] = $retweeted_status;
$status['friendica_author'] = $retweeted_status['friendica_author'];
}
}
// "uid" and "self" are only needed for some internal stuff, so remove it from here
unset($status["user"]["uid"]);
unset($status["user"]["self"]);
if ($item["coord"] != "") {
$coords = explode(' ', $item["coord"]);
if (count($coords) == 2) {
if ($type == "json") {
$status["geo"] = ['type' => 'Point',
'coordinates' => [(float) $coords[0],
(float) $coords[1]]];
} else {// Not sure if this is the official format - if someone founds a documentation we can check
$status["georss:point"] = $item["coord"];
}
}
}
$ret[] = $status; $ret[] = $status;
}; }
return $ret; return $ret;
} }
/**
* @param array $item Item record
* @param string $type Return format (atom, rss, xml, json)
* @param array $status_user User record of the item author, can be provided by api_item_get_user()
* @param array $author_user User record of the item author, can be provided by api_item_get_user()
* @param array $owner_user User record of the item owner, can be provided by api_item_get_user()
* @return array API-formatted status
* @throws BadRequestException
* @throws ImagickException
* @throws InternalServerErrorException
* @throws UnauthorizedException
*/
function api_format_item($item, $type = "json", $status_user = null, $author_user = null, $owner_user = null)
{
$a = \Friendica\BaseObject::getApp();
if (empty($status_user) || empty($author_user) || empty($owner_user)) {
list($status_user, $author_user, $owner_user) = api_item_get_user($a, $item);
}
localize_item($item);
$in_reply_to = api_in_reply_to($item);
$converted = api_convert_item($item);
if ($type == "xml") {
$geo = "georss:point";
} else {
$geo = "geo";
}
$status = [
'text' => $converted["text"],
'truncated' => false,
'created_at'=> api_date($item['created']),
'in_reply_to_status_id' => $in_reply_to['status_id'],
'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
'source' => (($item['app']) ? $item['app'] : 'web'),
'id' => intval($item['id']),
'id_str' => (string) intval($item['id']),
'in_reply_to_user_id' => $in_reply_to['user_id'],
'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
'in_reply_to_screen_name' => $in_reply_to['screen_name'],
$geo => null,
'favorited' => $item['starred'] ? true : false,
'user' => $status_user,
'friendica_author' => $author_user,
'friendica_owner' => $owner_user,
'friendica_private' => $item['private'] == 1,
//'entities' => NULL,
'statusnet_html' => $converted["html"],
'statusnet_conversation_id' => $item['parent'],
'external_url' => System::baseUrl() . "/display/" . $item['guid'],
'friendica_activities' => api_format_items_activities($item, $type),
];
if (count($converted["attachments"]) > 0) {
$status["attachments"] = $converted["attachments"];
}
if (count($converted["entities"]) > 0) {
$status["entities"] = $converted["entities"];
}
if ($status["source"] == 'web') {
$status["source"] = ContactSelector::networkToName($item['network'], $item['author-link']);
} elseif (ContactSelector::networkToName($item['network'], $item['author-link']) != $status["source"]) {
$status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['network'], $item['author-link']).')');
}
if ($item["id"] == $item["parent"]) {
$retweeted_item = api_share_as_retweet($item);
if ($retweeted_item !== false) {
$retweeted_status = $status;
$status['user'] = $status['friendica_owner'];
try {
$retweeted_status["user"] = api_get_user($a, $retweeted_item["author-id"]);
} catch (BadRequestException $e) {
// user not found. should be found?
/// @todo check if the user should be always found
$retweeted_status["user"] = [];
}
$rt_converted = api_convert_item($retweeted_item);
$retweeted_status['text'] = $rt_converted["text"];
$retweeted_status['statusnet_html'] = $rt_converted["html"];
$retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
$retweeted_status['created_at'] = api_date($retweeted_item['created']);
$status['retweeted_status'] = $retweeted_status;
$status['friendica_author'] = $retweeted_status['friendica_author'];}
}
// "uid" and "self" are only needed for some internal stuff, so remove it from here
unset($status["user"]["uid"]);
unset($status["user"]["self"]);
if ($item["coord"] != "") {
$coords = explode(' ', $item["coord"]);
if (count($coords) == 2) {
if ($type == "json") {
$status["geo"] = ['type' => 'Point',
'coordinates' => [(float) $coords[0],
(float) $coords[1]]];
} else {// Not sure if this is the official format - if someone founds a documentation we can check
$status["georss:point"] = $item["coord"];
}
}
}
return $status;
}
/** /**
* Returns the remaining number of API requests available to the user before the API limit is reached. * Returns the remaining number of API requests available to the user before the API limit is reached.
* *

29
tests/include/ApiTest.php
View file

@ -31,6 +31,18 @@ class ApiTest extends DatabaseTest
*/ */
protected $logOutput; protected $logOutput;
/** @var App */
protected $app;
/** @var array */
protected $selfUser;
/** @var array */
protected $friendUser;
/** @var array */
protected $otherUser;
protected $wrongUserId;
/** /**
* Create variables used by tests. * Create variables used by tests.
*/ */
@ -1272,31 +1284,30 @@ class ApiTest extends DatabaseTest
/** /**
* Test the api_status_show() function. * Test the api_status_show() function.
* @return void
*/ */
public function testApiStatusShow() public function testApiStatusShowWithJson()
{ {
$result = api_status_show('json'); $result = api_status_show('json', 1);
$this->assertStatus($result['status']); $this->assertStatus($result['status']);
} }
/** /**
* Test the api_status_show() function with an XML result. * Test the api_status_show() function with an XML result.
* @return void
*/ */
public function testApiStatusShowWithXml() public function testApiStatusShowWithXml()
{ {
$result = api_status_show('xml'); $result = api_status_show('xml', 1);
$this->assertXml($result, 'statuses'); $this->assertXml($result, 'statuses');
} }
/** /**
* Test the api_status_show() function with a raw result. * Test the api_get_last_status() function
* @return void
*/ */
public function testApiStatusShowWithRaw() public function testApiGetLastStatus()
{ {
$this->assertStatus(api_status_show('raw')); $item = api_get_last_status($this->selfUser['id'], $this->selfUser['id']);
$this->assertNotNull($item);
} }
/** /**