3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Module\Api\Mastodon;
24 use Friendica\Core\Protocol;
25 use Friendica\Core\System;
26 use Friendica\Database\DBA;
28 use Friendica\Model\Contact;
29 use Friendica\Model\Post;
30 use Friendica\Model\Tag;
31 use Friendica\Module\BaseApi;
32 use Friendica\Util\Network;
35 * @see https://docs.joinmastodon.org/methods/search/
37 class Search extends BaseApi
40 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
42 protected function rawContent(array $request = [])
44 self::checkAllowedScope(self::SCOPE_READ);
45 $uid = self::getCurrentUserID();
47 $request = $this->getRequest([
48 'account_id' => 0, // If provided, statuses returned will be authored only by this account
49 'max_id' => 0, // Return results older than this id
50 'min_id' => 0, // Return results immediately newer than this id
51 'type' => '', // Enum(accounts, hashtags, statuses)
52 'exclude_unreviewed' => false, // Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags.
53 'q' => '', // The search query
54 'resolve' => false, // Attempt WebFinger lookup. Defaults to false.
55 'limit' => 20, // Maximum number of results to load, per type. Defaults to 20. Max 40.
56 'offset' => 0, // Offset in search results. Used for pagination. Defaults to 0.
57 'following' => false, // Only include accounts that the user is following. Defaults to false.
60 if (empty($request['q'])) {
61 DI::mstdnError()->UnprocessableEntity();
64 $limit = min($request['limit'], 40);
66 $result = ['accounts' => [], 'statuses' => [], 'hashtags' => []];
68 if (empty($request['type']) || ($request['type'] == 'accounts')) {
69 $result['accounts'] = self::searchAccounts($uid, $request['q'], $request['resolve'], $limit, $request['offset'], $request['following']);
71 if ((empty($request['type']) || ($request['type'] == 'statuses')) && (strpos($request['q'], '@') == false)) {
72 $result['statuses'] = self::searchStatuses($uid, $request['q'], $request['account_id'], $request['max_id'], $request['min_id'], $limit, $request['offset']);
74 if ((empty($request['type']) || ($request['type'] == 'hashtags')) && (strpos($request['q'], '@') == false)) {
75 $result['hashtags'] = self::searchHashtags($request['q'], $request['exclude_unreviewed'], $limit, $request['offset'], $this->parameters['version']);
78 System::jsonExit($result);
81 private static function searchAccounts(int $uid, string $q, bool $resolve, int $limit, int $offset, bool $following)
85 if ((strrpos($q, '@') > 0) || Network::isValidHttpUrl($q)) {
86 $id = Contact::getIdForURL($q, 0, $resolve ? null : false);
89 $accounts[] = DI::mstdnAccount()->createFromContactId($id, $uid);
93 if (empty($accounts)) {
94 $contacts = Contact::searchByName($q, '', $following ? $uid : 0, $limit, $offset);
95 foreach ($contacts as $contact) {
96 $accounts[] = DI::mstdnAccount()->createFromContactId($contact['id'], $uid);
98 DBA::close($contacts);
104 private static function searchStatuses(int $uid, string $q, string $account_id, int $max_id, int $min_id, int $limit, int $offset)
106 $params = ['order' => ['uri-id' => true], 'limit' => [$offset, $limit]];
108 if (substr($q, 0, 1) == '#') {
109 $condition = ["`name` = ? AND (`uid` = ? OR (`uid` = ? AND NOT `global`))
110 AND (`network` IN (?, ?, ?, ?) OR (`uid` = ? AND `uid` != ?))",
111 substr($q, 1), 0, $uid, Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, $uid, 0];
112 $table = 'tag-search-view';
114 $condition = ["`uri-id` IN (SELECT `uri-id` FROM `post-content` WHERE MATCH (`title`, `content-warning`, `body`) AGAINST (? IN BOOLEAN MODE))
115 AND (`uid` = ? OR (`uid` = ? AND NOT `global`)) AND (`network` IN (?, ?, ?, ?) OR (`uid` = ? AND `uid` != ?))",
116 str_replace('@', ' ', $q), 0, $uid, Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, $uid, 0];
117 $table = 'post-user-view';
120 if (!empty($max_id)) {
121 $condition = DBA::mergeConditions($condition, ["`uri-id` < ?", $max_id]);
124 if (!empty($since_id)) {
125 $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $since_id]);
128 if (!empty($min_id)) {
129 $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $min_id]);
131 $params['order'] = ['uri-id'];
134 $items = DBA::select($table, ['uri-id'], $condition, $params);
137 while ($item = Post::fetch($items)) {
138 self::setBoundaries($item['uri-id']);
139 $statuses[] = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid);
143 if (!empty($min_id)) {
144 $statuses = array_reverse($statuses);
147 self::setLinkHeader();
151 private static function searchHashtags(string $q, bool $exclude_unreviewed, int $limit, int $offset, int $version)
155 $params = ['order' => ['name'], 'limit' => [$offset, $limit]];
157 $condition = ["`id` IN (SELECT `tid` FROM `post-tag` WHERE `type` = ?) AND `name` LIKE ?", Tag::HASHTAG, $q . '%'];
159 $tags = DBA::select('tag', ['name'], $condition, $params);
162 foreach ($tags as $tag) {
164 $hashtags[] = $tag['name'];
166 $hashtags[] = new \Friendica\Object\Api\Mastodon\Tag(DI::baseUrl(), $tag);