From c9110e03e144c053222f33166912f45cd34ea9bc Mon Sep 17 00:00:00 2001 From: Michael Date: Mon, 17 May 2021 22:22:51 +0000 Subject: [PATCH] API: Search endpoint --- doc/API-Mastodon.md | 2 +- src/Module/Api/Mastodon/Accounts/Search.php | 8 +- src/Module/Api/Mastodon/Search.php | 194 ++++++++++++++++++++ static/routes.config.php | 2 +- 4 files changed, 200 insertions(+), 6 deletions(-) create mode 100644 src/Module/Api/Mastodon/Search.php diff --git a/doc/API-Mastodon.md b/doc/API-Mastodon.md index 3f21d823a..1d1f497d3 100644 --- a/doc/API-Mastodon.md +++ b/doc/API-Mastodon.md @@ -109,6 +109,7 @@ These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/en - [`GET /api/v1/timelines/public`](https://docs.joinmastodon.org/methods/timelines/) - [`GET /api/v1/timelines/tag/:hashtag`](https://docs.joinmastodon.org/methods/timelines/) - [`GET /api/v1/trends`](https://docs.joinmastodon.org/methods/instance/trends/) +- [`GET /api/v2/search`](https://docs.joinmastodon.org/methods/search/) ## Currently unimplemented endpoints @@ -122,7 +123,6 @@ These emdpoints are planned to be implemented - [`POST /api/v1/conversations/:id/read`](https://docs.joinmastodon.org/methods/timelines/conversations/) - [`GET /api/v1/instance/activity`](https://docs.joinmastodon.org/methods/instance#weekly-activity) - [`GET /api/v1/timelines/direct`](https://docs.joinmastodon.org/methods/timelines/) -- [`GET /api/v2/search`](https://docs.joinmastodon.org/methods/search/) ## Non supportable endpoints diff --git a/src/Module/Api/Mastodon/Accounts/Search.php b/src/Module/Api/Mastodon/Accounts/Search.php index 9f1d0aadf..f74e35713 100644 --- a/src/Module/Api/Mastodon/Accounts/Search.php +++ b/src/Module/Api/Mastodon/Accounts/Search.php @@ -44,13 +44,13 @@ class Search extends BaseApi $uid = self::getCurrentUserID(); // What to search for - $q = (int)!isset($_REQUEST['q']) ? 0 : $_REQUEST['q']; + $q = $_REQUEST['q'] ?? ''; // Maximum number of results. Defaults to 40. - $limit = (int)!isset($_REQUEST['limit']) ? 40 : $_REQUEST['limit']; + $limit = (int)$_REQUEST['limit'] ?? 40; // Attempt WebFinger lookup. Defaults to false. Use this when q is an exact address. - $resolve = (int)!isset($_REQUEST['resolve']) ? 0 : $_REQUEST['resolve']; + $resolve = (bool)!isset($_REQUEST['resolve']) ? false : ($_REQUEST['resolve'] == 'true'); // Only who the user is following. Defaults to false. - $following = (int)!isset($_REQUEST['following']) ? 0 : $_REQUEST['following']; + $following = (bool)!isset($_REQUEST['following']) ? false : ($_REQUEST['following'] == 'true'); $accounts = []; diff --git a/src/Module/Api/Mastodon/Search.php b/src/Module/Api/Mastodon/Search.php new file mode 100644 index 000000000..5bd59d89a --- /dev/null +++ b/src/Module/Api/Mastodon/Search.php @@ -0,0 +1,194 @@ +. + * + */ + +namespace Friendica\Module\Api\Mastodon; + +use Friendica\Core\Protocol; +use Friendica\Core\Search as CoreSearch; +use Friendica\Core\System; +use Friendica\Database\DBA; +use Friendica\DI; +use Friendica\Model\Contact; +use Friendica\Model\Post; +use Friendica\Model\Tag; +use Friendica\Module\BaseApi; +use Friendica\Object\Search\ContactResult; + +/** + * @see https://docs.joinmastodon.org/methods/search/ + */ +class Search extends BaseApi +{ + /** + * @param array $parameters + * @throws \Friendica\Network\HTTPException\InternalServerErrorException + */ + public static function rawContent(array $parameters = []) + { + self::login(self::SCOPE_READ); + $uid = self::getCurrentUserID(); + + // If provided, statuses returned will be authored only by this account + $account_id = $_REQUEST['account_id'] ?? ''; + // Return results older than this id + $max_id = (int)($_REQUEST['max_id'] ?? 0); + // Return results immediately newer than this id + $min_id = (int)($_REQUEST['min_id'] ?? 0); + // Enum(accounts, hashtags, statuses) + $type = $_REQUEST['type'] ?? ''; + // Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags. + $exclude_unreviewed = (bool)!isset($_REQUEST['exclude_unreviewed']) ? false : ($_REQUEST['exclude_unreviewed'] == 'true'); + // The search query + $q = $_REQUEST['q'] ?? ''; + // Attempt WebFinger lookup. Defaults to false. + $resolve = (bool)!isset($_REQUEST['resolve']) ? false : ($_REQUEST['resolve'] == 'true'); + // Maximum number of results to load, per type. Defaults to 20. Max 40. + $limit = (int)($_REQUEST['limit'] ?? 20); + // Offset in search results. Used for pagination. Defaults to 0. + $offset = (int)($_REQUEST['offset'] ?? 0); + // Only who the user is following. Defaults to false. + $following = (bool)!isset($_REQUEST['following']) ? false : ($_REQUEST['following'] == 'true'); + + $result = ['accounts' => [], 'statuses' => [], 'hashtags' => []]; + + if (empty($type) || ($type == 'accounts')) { + $result['accounts'] = self::searchAccounts($uid, $q, $resolve, $limit, $offset, $following); + } + if ((empty($type) || ($type == 'statuses')) && (strpos($q, '@') == false)) { + $result['statuses'] = self::searchStatuses($uid, $q, $account_id, $max_id, $min_id, $limit, $offset); + } + if ((empty($type) || ($type == 'hashtags')) && (strpos($q, '@') == false)) { + $result['hashtags'] = self::searchHashtags($q, $exclude_unreviewed, $limit, $offset); + } + + System::jsonExit($result); + } + + private static function searchAccounts(int $uid, string $q, bool $resolve, int $limit, int $offset, bool $following) + { + $accounts = []; + + if (!$following) { + if ((strrpos($q, '@') > 0) && $resolve) { + $results = CoreSearch::getContactsFromProbe($q); + } + + if (empty($results)) { + if (DI::config()->get('system', 'poco_local_search')) { + $results = CoreSearch::getContactsFromLocalDirectory($q, CoreSearch::TYPE_ALL, 0, $limit); + } elseif (!empty(DI::config()->get('system', 'directory'))) { + $results = CoreSearch::getContactsFromGlobalDirectory($q, CoreSearch::TYPE_ALL, 1); + } + } + if (!empty($results)) { + $counter = 0; + foreach ($results->getResults() as $result) { + if (++$counter > $limit) { + continue; + } + if ($result instanceof ContactResult) { + $id = Contact::getIdForURL($result->getUrl(), 0, false); + + $accounts[] = DI::mstdnAccount()->createFromContactId($id, $uid); + } + } + } + } else { + $contacts = Contact::searchByName($q, '', $uid); + + $counter = 0; + foreach ($contacts as $contact) { + if (!in_array($contact['rel'], [Contact::SHARING, Contact::FRIEND])) { + continue; + } + if (++$counter > $limit) { + continue; + } + $accounts[] = DI::mstdnAccount()->createFromContactId($contact['id'], $uid); + } + DBA::close($contacts); + } + + return $accounts; + } + + private static function searchStatuses(int $uid, string $q, string $account_id, int $max_id, int $min_id, int $limit, int $offset) + { + $params = ['order' => ['uri-id' => true], 'limit' => [$offset, $limit]]; + + if (substr($q, 0, 1) == '#') { + $condition = ["`name` = ? AND (`uid` = ? OR (`uid` = ? AND NOT `global`)) + AND (`network` IN (?, ?, ?, ?) OR (`uid` = ? AND `uid` != ?))", + substr($q, 1), 0, $uid, Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, $uid, 0]; + $table = 'tag-search-view'; + } else { + $condition = ["`uri-id` IN (SELECT `uri-id` FROM `post-content` WHERE MATCH (`title`, `content-warning`, `body`) AGAINST (? IN BOOLEAN MODE)) + AND (`uid` = ? OR (`uid` = ? AND NOT `global`)) AND (`network` IN (?, ?, ?, ?) OR (`uid` = ? AND `uid` != ?))", + str_replace('@', ' ', $q), 0, $uid, Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, $uid, 0]; + $table = 'post-user-view'; + } + + if (!empty($max_id)) { + $condition = DBA::mergeConditions($condition, ["`uri-id` < ?", $max_id]); + } + + if (!empty($since_id)) { + $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $since_id]); + } + + if (!empty($min_id)) { + $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $min_id]); + + $params['order'] = ['uri-id']; + } + + $items = DBA::select($table, ['uri-id'], $condition, $params); + + $statuses = []; + while ($item = Post::fetch($items)) { + $statuses[] = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid); + } + DBA::close($items); + + if (!empty($min_id)) { + array_reverse($statuses); + } + + return $statuses; + } + + private static function searchHashtags(string $q, bool $exclude_unreviewed, int $limit, int $offset) + { + $q = ltrim($q, '#'); + $params = ['order' => ['name'], 'limit' => [$offset, $limit]]; + + $condition = ["`id` IN (SELECT `tid` FROM `post-tag` WHERE `type` = ? AND `tid` = `id`) AND `name` LIKE ?", Tag::HASHTAG, $q . '%']; + + $tags = DBA::select('tag', ['name'], $condition, $params); + + $hashtags = []; + foreach ($tags as $tag) { + $hashtags[] = new \Friendica\Object\Api\Mastodon\Tag(DI::baseUrl(), $tag); + } + + return $hashtags; + } +} diff --git a/static/routes.config.php b/static/routes.config.php index 580905af9..c91751b17 100644 --- a/static/routes.config.php +++ b/static/routes.config.php @@ -150,7 +150,7 @@ return [ '/trends' => [Module\Api\Mastodon\Trends::class, [R::GET ]], ], '/v2' => [ - '/search' => [Module\Api\Mastodon\Unimplemented::class, [R::GET ]], // @todo + '/search' => [Module\Api\Mastodon\Search::class, [R::GET ]], ], '/friendica' => [ '/profile/show' => [Module\Api\Friendica\Profile\Show::class, [R::GET ]],