diff --git a/doc/API-Mastodon.md b/doc/API-Mastodon.md index 3f21d823a4..1d1f497d30 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 9f1d0aadfe..30031a3d1c 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 = ($_REQUEST['resolve'] ?? '') == 'true'; // Only who the user is following. Defaults to false. - $following = (int)!isset($_REQUEST['following']) ? 0 : $_REQUEST['following']; + $following = ($_REQUEST['following'] ?? '') == 'true'; $accounts = []; diff --git a/src/Module/Api/Mastodon/Notifications.php b/src/Module/Api/Mastodon/Notifications.php index 30e1060d82..3dfcaa6689 100644 --- a/src/Module/Api/Mastodon/Notifications.php +++ b/src/Module/Api/Mastodon/Notifications.php @@ -50,23 +50,29 @@ class Notifications extends BaseApi System::jsonExit(DI::mstdnNotification()->createFromNotifyId($id)); } + $request = self::getRequest(['max_id' => 0, 'since_id' => 0, 'min_id' => 0, 'limit' => 20, + 'exclude_types' => [], 'account_id' => 0, 'with_muted' => false]); + // Return results older than this ID - $max_id = (int)!isset($_REQUEST['max_id']) ? 0 : $_REQUEST['max_id']; + $max_id = $request['max_id']; // Return results newer than this ID - $since_id = (int)!isset($_REQUEST['since_id']) ? 0 : $_REQUEST['since_id']; + $since_id = $request['since_id']; // Return results immediately newer than this ID - $min_id = (int)!isset($_REQUEST['min_id']) ? 0 : $_REQUEST['min_id']; + $min_id = $request['min_id']; // Maximum number of results to return (default 20) - $limit = (int)!isset($_REQUEST['limit']) ? 20 : $_REQUEST['limit']; + $limit = $request['limit']; // Array of types to exclude (follow, favourite, reblog, mention, poll, follow_request) - $exclude_types = $_REQUEST['exclude_types'] ?? []; + $exclude_types = $request['exclude_types']; // Return only notifications received from this account - $account_id = (int)!isset($_REQUEST['account_id']) ? 0 : $_REQUEST['account_id']; + $account_id = $request['account_id']; + + // Unknown parameter + $with_muted = $request['with_muted']; $params = ['order' => ['id' => true], 'limit' => $limit]; diff --git a/src/Module/Api/Mastodon/Search.php b/src/Module/Api/Mastodon/Search.php new file mode 100644 index 0000000000..592175149e --- /dev/null +++ b/src/Module/Api/Mastodon/Search.php @@ -0,0 +1,193 @@ +. + * + */ + +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(); + + $request = self::getRequest([ + 'account_id' => 0, // If provided, statuses returned will be authored only by this account + 'max_id' => 0, // Return results older than this id + 'min_id' => 0, // Return results immediately newer than this id + 'type' => '', // Enum(accounts, hashtags, statuses) + 'exclude_unreviewed' => false, // Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags. + 'q' => '', // The search query + 'resolve' => false, // Attempt WebFinger lookup. Defaults to false. + 'limit' => 20, // Maximum number of results to load, per type. Defaults to 20. Max 40. + 'offset' => 0, // Maximum number of results to load, per type. Defaults to 20. Max 40. + 'following' => false, // Only who the user is following. Defaults to false. + ]); + + if (empty($request['q'])) { + DI::mstdnError()->UnprocessableEntity(); + } + + $limit = min($request['limit'], 40); + + $result = ['accounts' => [], 'statuses' => [], 'hashtags' => []]; + + if (empty($request['type']) || ($request['type'] == 'accounts')) { + $result['accounts'] = self::searchAccounts($uid, $request['q'], $request['resolve'], $limit, $request['offset'], $request['following']); + } + if ((empty($request['type']) || ($request['type'] == 'statuses')) && (strpos($request['q'], '@') == false)) { + $result['statuses'] = self::searchStatuses($uid, $request['q'], $request['account_id'], $request['max_id'], $request['min_id'], $limit, $request['offset']); + } + if ((empty($request['type']) || ($request['type'] == 'hashtags')) && (strpos($request['q'], '@') == false)) { + $result['hashtags'] = self::searchHashtags($request['q'], $request['exclude_unreviewed'], $limit, $request['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 = ["EXISTS(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/src/Module/BaseApi.php b/src/Module/BaseApi.php index db4531d91c..c12872104b 100644 --- a/src/Module/BaseApi.php +++ b/src/Module/BaseApi.php @@ -136,6 +136,43 @@ class BaseApi extends BaseModule System::jsonError(501, $errorobj->toArray()); } + /** + * Processes data from GET requests and sets defaults + * + * @return array request data + */ + public static function getRequest(array $defaults) { + $request = []; + + foreach ($defaults as $parameter => $defaultvalue) { + if (is_string($defaultvalue)) { + $request[$parameter] = $_REQUEST[$parameter] ?? $defaultvalue; + } elseif (is_int($defaultvalue)) { + $request[$parameter] = (int)($_REQUEST[$parameter] ?? $defaultvalue); + } elseif (is_float($defaultvalue)) { + $request[$parameter] = (float)($_REQUEST[$parameter] ?? $defaultvalue); + } elseif (is_array($defaultvalue)) { + $request[$parameter] = $_REQUEST[$parameter] ?? []; + } elseif (is_bool($defaultvalue)) { + $request[$parameter] = in_array(strtolower($_REQUEST[$parameter] ?? ''), ['true', '1']); + } else { + Logger::notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]); + } + } + + foreach ($_REQUEST ?? [] as $parameter => $value) { + if ($parameter == 'pagename') { + continue; + } + if (!in_array($parameter, array_keys($defaults))) { + Logger::notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => DI::args()->getCommand()]); + } + } + + Logger::debug('Got request parameters', ['request' => $request, 'command' => DI::args()->getCommand()]); + return $request; + } + /** * Get post data that is transmitted as JSON * diff --git a/static/routes.config.php b/static/routes.config.php index 580905af9c..c91751b176 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 ]],