]> git.mxchange.org Git - friendica.git/blob - src/Module/Api/Mastodon/Search.php
Improved url detection
[friendica.git] / src / Module / Api / Mastodon / Search.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2022, the Friendica project
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
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.
11  *
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.
16  *
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/>.
19  *
20  */
21
22 namespace Friendica\Module\Api\Mastodon;
23
24 use Friendica\Core\Protocol;
25 use Friendica\Core\Search as CoreSearch;
26 use Friendica\Core\System;
27 use Friendica\Database\DBA;
28 use Friendica\DI;
29 use Friendica\Model\Contact;
30 use Friendica\Model\Post;
31 use Friendica\Model\Tag;
32 use Friendica\Module\BaseApi;
33 use Friendica\Object\Search\ContactResult;
34 use Friendica\Util\Network;
35
36 /**
37  * @see https://docs.joinmastodon.org/methods/search/
38  */
39 class Search extends BaseApi
40 {
41         /**
42          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
43          */
44         protected function rawContent(array $request = [])
45         {
46                 self::checkAllowedScope(self::SCOPE_READ);
47                 $uid = self::getCurrentUserID();
48
49                 $request = $this->getRequest([
50                         'account_id'         => 0,     // If provided, statuses returned will be authored only by this account
51                         'max_id'             => 0,     // Return results older than this id
52                         'min_id'             => 0,     // Return results immediately newer than this id
53                         'type'               => '',    // Enum(accounts, hashtags, statuses)
54                         'exclude_unreviewed' => false, // Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags.
55                         'q'                  => '',    // The search query
56                         'resolve'            => false, // Attempt WebFinger lookup. Defaults to false.
57                         'limit'              => 20,    // Maximum number of results to load, per type. Defaults to 20. Max 40.
58                         'offset'             => 0,     // Offset in search results. Used for pagination. Defaults to 0.
59                         'following'          => false, // Only include accounts that the user is following. Defaults to false.
60                 ], $request);
61
62                 if (empty($request['q'])) {
63                         DI::mstdnError()->UnprocessableEntity();
64                 }
65
66                 $limit = min($request['limit'], 40);
67
68                 $result = ['accounts' => [], 'statuses' => [], 'hashtags' => []];
69
70                 if (empty($request['type']) || ($request['type'] == 'accounts')) {
71                         $result['accounts'] = self::searchAccounts($uid, $request['q'], $request['resolve'], $limit, $request['offset'], $request['following']);
72                 }
73                 if ((empty($request['type']) || ($request['type'] == 'statuses')) && (strpos($request['q'], '@') == false)) {
74                         $result['statuses'] = self::searchStatuses($uid, $request['q'], $request['account_id'], $request['max_id'], $request['min_id'], $limit, $request['offset']);
75                 }
76                 if ((empty($request['type']) || ($request['type'] == 'hashtags')) && (strpos($request['q'], '@') == false)) {
77                         $result['hashtags'] = self::searchHashtags($request['q'], $request['exclude_unreviewed'], $limit, $request['offset'], $this->parameters['version']);
78                 }
79
80                 System::jsonExit($result);
81         }
82
83         private static function searchAccounts(int $uid, string $q, bool $resolve, int $limit, int $offset, bool $following)
84         {
85                 $accounts = [];
86
87                 if ($resolve) {
88                         if ((strrpos($q, '@') > 0) || Network::isValidHttpUrl($q)) {
89                                 $results = CoreSearch::getContactsFromProbe($q);
90                         }
91
92                         if (!empty($results)) {
93                                 $counter = 0;
94                                 foreach ($results->getResults() as $result) {
95                                         if (++$counter > $limit) {
96                                                 continue;
97                                         }
98                                         if ($result instanceof ContactResult) {
99                                                 $id = Contact::getIdForURL($result->getUrl(), 0, false);
100
101                                                 $accounts[] = DI::mstdnAccount()->createFromContactId($id, $uid);
102                                         }
103                                 }
104                         }
105                 }
106
107                 if (count($accounts) < $limit) {
108                         $contacts = Contact::searchByName($q, '', $following ? $uid : 0, $limit - count($accounts), $offset);
109                         foreach ($contacts as $contact) {
110                                 $accounts[] = DI::mstdnAccount()->createFromContactId($contact['id'], $uid);
111                         }
112                         DBA::close($contacts);
113                 }
114
115                 return $accounts;
116         }
117
118         private static function searchStatuses(int $uid, string $q, string $account_id, int $max_id, int $min_id, int $limit, int $offset)
119         {
120                 $params = ['order' => ['uri-id' => true], 'limit' => [$offset, $limit]];
121
122                 if (substr($q, 0, 1) == '#') {
123                         $condition = ["`name` = ? AND (`uid` = ? OR (`uid` = ? AND NOT `global`))
124                                 AND (`network` IN (?, ?, ?, ?) OR (`uid` = ? AND `uid` != ?))",
125                                 substr($q, 1), 0, $uid, Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, $uid, 0];
126                         $table = 'tag-search-view';
127                 } else {
128                         $condition = ["`uri-id` IN (SELECT `uri-id` FROM `post-content` WHERE MATCH (`title`, `content-warning`, `body`) AGAINST (? IN BOOLEAN MODE))
129                                 AND (`uid` = ? OR (`uid` = ? AND NOT `global`)) AND (`network` IN (?, ?, ?, ?) OR (`uid` = ? AND `uid` != ?))",
130                                 str_replace('@', ' ', $q), 0, $uid, Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, $uid, 0];
131                         $table = 'post-user-view';
132                 }
133
134                 if (!empty($max_id)) {
135                         $condition = DBA::mergeConditions($condition, ["`uri-id` < ?", $max_id]);
136                 }
137
138                 if (!empty($since_id)) {
139                         $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $since_id]);
140                 }
141
142                 if (!empty($min_id)) {
143                         $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $min_id]);
144
145                         $params['order'] = ['uri-id'];
146                 }
147
148                 $items = DBA::select($table, ['uri-id'], $condition, $params);
149
150                 $statuses = [];
151                 while ($item = Post::fetch($items)) {
152                         self::setBoundaries($item['uri-id']);
153                         $statuses[] = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid);
154                 }
155                 DBA::close($items);
156
157                 if (!empty($min_id)) {
158                         $statuses = array_reverse($statuses);
159                 }
160
161                 self::setLinkHeader();
162                 return $statuses;
163         }
164
165         private static function searchHashtags(string $q, bool $exclude_unreviewed, int $limit, int $offset, int $version)
166         {
167                 $q = ltrim($q, '#');
168
169                 $params = ['order' => ['name'], 'limit' => [$offset, $limit]];
170
171                 $condition = ["`id` IN (SELECT `tid` FROM `post-tag` WHERE `type` = ?) AND `name` LIKE ?", Tag::HASHTAG, $q . '%'];
172
173                 $tags = DBA::select('tag', ['name'], $condition, $params);
174
175                 $hashtags = [];
176                 foreach ($tags as $tag) {
177                         if ($version == 1) {
178                                 $hashtags[] = $tag['name'];
179                         } else {
180                                 $hashtags[] = new \Friendica\Object\Api\Mastodon\Tag(DI::baseUrl(), $tag);
181                         }
182                 }
183
184                 return $hashtags;
185         }
186 }