]> git.mxchange.org Git - friendica.git/blobdiff - include/api.php
Test fix: Add expected author-network field to api_get_item() result
[friendica.git] / include / api.php
index 64b7409fa2a77ea8493180c411d95f497d0b1e4a..841ed1a7192a633e8ff587114141b84548e5f1fb 100644 (file)
@@ -775,15 +775,17 @@ function api_item_get_user(App $a, $item)
 {
        $status_user = api_get_user($a, defaults($item, 'author-id', null));
 
+       $author_user = $status_user;
+
        $status_user["protected"] = defaults($item, 'private', 0);
 
        if (defaults($item, 'thr-parent', '') == defaults($item, 'uri', '')) {
                $owner_user = api_get_user($a, defaults($item, 'owner-id', null));
        } else {
-               $owner_user = $status_user;
+               $owner_user = $author_user;
        }
 
-       return ([$status_user, $owner_user]);
+       return ([$status_user, $author_user, $owner_user]);
 }
 
 /**
@@ -930,7 +932,6 @@ function api_format_data($root_element, $type, $data)
  */
 function api_account_verify_credentials($type)
 {
-
        $a = \get_app();
 
        if (api_user() === false) {
@@ -952,13 +953,9 @@ function api_account_verify_credentials($type)
 
        // - Adding last status
        if (!$skip_status) {
-               $user_info["status"] = api_status_show("raw");
-               if (isset($user_info["status"])) {
-                       if (!is_array($user_info["status"]) || !count($user_info["status"])) {
-                               unset($user_info["status"]);
-                       } else {
-                               unset($user_info["status"]["user"]);
-                       }
+               $last_status = api_get_last_status($user_info['pid'], $user_info['uid'], $type);
+               if ($last_status) {
+                       $user_info['status'] = $last_status;
                }
        }
 
@@ -1242,105 +1239,64 @@ function api_media_upload()
 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
 
 /**
- *
- * @param string $type Return type (atom, rss, xml, json)
- *
+ * @param string $type    Return format (atom, rss, xml, json)
  * @param int    $item_id
- * @return array|string
- * @throws BadRequestException
- * @throws ImagickException
- * @throws InternalServerErrorException
- * @throws UnauthorizedException
+ * @return string
+ * @throws Exception
  */
-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);
-
-       Logger::log('api_status_show: user_info: '.print_r($user_info, true), Logger::DEBUG);
+       $status_info = [];
 
-       if (!empty($item_id)) {
-               // 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]];
+       $item = api_get_item(['id' => $item_id]);
+       if ($item) {
+               $status_info = api_format_item($item, $type);
        }
 
-       if ($type == "raw") {
-               $condition['private'] = false;
-       }
-
-       $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
-
-       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";
-               }
-
-               $status_info = [
-                       'created_at' => api_date($lastwall['created']),
-                       'id' => intval($lastwall['id']),
-                       'id_str' => (string) $lastwall['id'],
-                       'text' => $converted["text"],
-                       'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
-                       'truncated' => false,
-                       'in_reply_to_status_id' => $in_reply_to['status_id'],
-                       'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
-                       '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'],
-                       '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'],
-               ];
+       Logger::info(API_LOG_PREFIX . 'End', ['action' => 'get_status', 'status_info' => $status_info]);
 
-               if (count($converted["attachments"]) > 0) {
-                       $status_info["attachments"] = $converted["attachments"];
-               }
+       return api_format_data('statuses', $type, ['status' => $status_info]);
+}
 
-               if (count($converted["entities"]) > 0) {
-                       $status_info["entities"] = $converted["entities"];
-               }
+/**
+ * Retrieves the last public status of the provided user info
+ *
+ * @param int    $ownerId Public contact Id
+ * @param int    $uid     User Id
+ * @param string $type    Return format (atom, rss, xml, json)
+ * @return array
+ * @throws Exception
+ */
+function api_get_last_status($ownerId, $uid, $type = 'json')
+{
+       $condition = [
+               'owner-id' => $ownerId,
+               'uid'      => $uid,
+               'gravity'  => [GRAVITY_PARENT, GRAVITY_COMMENT],
+               'private'  => false
+       ];
 
-               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']).')');
-               }
+       $item = api_get_item($condition);
 
-               // "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"]);
+       $status_info = api_format_item($item, $type);
 
-               Logger::log('status_info: '.print_r($status_info, true), Logger::DEBUG);
+       return $status_info;
+}
 
-               if ($type == "raw") {
-                       return $status_info;
-               }
+/**
+ * Retrieves a single item record based on the provided condition and converts it for API use.
+ *
+ * @param array $condition Item table condition array
+ * @return array
+ * @throws Exception
+ */
+function api_get_item(array $condition)
+{
+       $item = Item::selectFirst(Item::DISPLAY_FIELDLIST, $condition, ['order' => ['id' => true]]);
 
-               return api_format_data("statuses", $type, ['status' => $status_info]);
-       }
+       return $item;
 }
 
 /**
@@ -1357,66 +1313,20 @@ function api_status_show($type, $item_id = 0)
  */
 function api_users_show($type)
 {
-       $a = \get_app();
+       $a = \Friendica\BaseObject::getApp();
 
        $user_info = api_get_user($a);
 
-       $condition = ['owner-id' => $user_info['pid'], 'uid' => api_user(),
-               'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'private' => false];
-       $lastwall = Item::selectFirst(Item::ITEM_FIELDLIST, $condition, ['order' => ['id' => true]]);
-
-       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']) . ')');
-               }
+       $lastStatus = api_get_last_status($user_info['pid'], $user_info['uid'], $type);
+       if ($lastStatus) {
+               $user_info['status'] = $lastStatus;
        }
 
        // "uid" and "self" are only needed for some internal stuff, so remove it from here
-       unset($user_info["uid"]);
-       unset($user_info["self"]);
+       unset($user_info['uid']);
+       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
@@ -2970,7 +2880,7 @@ function api_format_items_profiles($profile_row)
 /**
  * @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 bool   $filter_user filter items by $user_info
  * @param string $type        Return type (atom, rss, xml, json)
@@ -2980,111 +2890,139 @@ function api_format_items_profiles($profile_row)
  * @throws InternalServerErrorException
  * @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 = [];
 
-       foreach ((array)$r as $item) {
-               localize_item($item);
-               list($status_user, $owner_user) = api_item_get_user($a, $item);
+       foreach ((array)$items as $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
                if ($filter_user && ($status_user["id"] != $user_info["id"])) {
                        continue;
                }
 
-               $in_reply_to = api_in_reply_to($item);
+               $status = api_format_item($item, $type, $status_user, $owner_user);
 
-               $converted = api_convert_item($item);
+               $ret[] = $status;
+       }
 
-               if ($type == "xml") {
-                       $geo = "georss:point";
-               } else {
-                       $geo = "geo";
-               }
+       return $ret;
+}
 
-               $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_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),
-               ];
+/**
+ * @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 $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, $owner_user = null)
+{
+       $a = \Friendica\BaseObject::getApp();
 
-               if (count($converted["attachments"]) > 0) {
-                       $status["attachments"] = $converted["attachments"];
-               }
+       if (empty($status_user) || empty($owner_user)) {
+               list($status_user, $owner_user) = api_item_get_user($a, $item);
+       }
 
-               if (count($converted["entities"]) > 0) {
-                       $status["entities"] = $converted["entities"];
-               }
+       localize_item($item);
 
-               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']).')');
-               }
+       $in_reply_to = api_in_reply_to($item);
 
-               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"] = [];
-                               }
+       $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"];
+       }
 
-                               $rt_converted = api_convert_item($retweeted_item);
+       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']).')');
+       }
 
-                               $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;
+       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"] = [];
                        }
-               }
 
-               // "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"];
-                               }
+                       $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;
-       };
-       return $ret;
+       }
+
+       return $status;
 }
 
 /**
@@ -5953,7 +5891,7 @@ function api_friendica_notification($type)
        }
        $nm = new NotificationsManager();
 
-       $notes = $nm->getAll([], "+seen -date", 50);
+       $notes = $nm->getAll([], ['seen' => 'ASC', 'date' => 'DESC'], 50);
 
        if ($type == "xml") {
                $xmlnotes = [];