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\Search;
24 use Friendica\Content\Nav;
25 use Friendica\Content\Pager;
26 use Friendica\Content\Text\HTML;
27 use Friendica\Content\Widget;
28 use Friendica\Core\Cache\Enum\Duration;
29 use Friendica\Core\Logger;
30 use Friendica\Core\Renderer;
31 use Friendica\Core\Search;
32 use Friendica\Core\Session;
33 use Friendica\Database\DBA;
35 use Friendica\Model\Contact;
36 use Friendica\Model\Item;
37 use Friendica\Model\Post;
38 use Friendica\Model\Tag;
39 use Friendica\Module\BaseSearch;
40 use Friendica\Network\HTTPException;
41 use Friendica\Util\Network;
43 class Index extends BaseSearch
45 protected function content(array $request = []): string
47 $search = (!empty($_GET['q']) ? trim(rawurldecode($_GET['q'])) : '');
49 if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) {
50 throw new HTTPException\ForbiddenException(DI::l10n()->t('Public access denied.'));
53 if (DI::config()->get('system', 'local_search') && !Session::isAuthenticated()) {
54 throw new HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a search.'));
57 if (DI::config()->get('system', 'permit_crawling') && !Session::isAuthenticated()) {
59 // 10 requests are "free", after the 11th only a call per minute is allowed
61 $free_crawls = intval(DI::config()->get('system', 'free_crawls'));
62 if ($free_crawls == 0)
65 $crawl_permit_period = intval(DI::config()->get('system', 'crawl_permit_period'));
66 if ($crawl_permit_period == 0)
67 $crawl_permit_period = 10;
69 $remote = $_SERVER['REMOTE_ADDR'];
70 $result = DI::cache()->get('remote_search:' . $remote);
71 if (!is_null($result)) {
72 $resultdata = json_decode($result);
73 if (($resultdata->time > (time() - $crawl_permit_period)) && ($resultdata->accesses > $free_crawls)) {
74 throw new HTTPException\TooManyRequestsException(DI::l10n()->t('Only one search per minute is permitted for not logged in users.'));
76 DI::cache()->set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => $resultdata->accesses + 1]), Duration::HOUR);
78 DI::cache()->set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => 1]), Duration::HOUR);
83 DI::page()['aside'] .= Widget\SavedSearches::getHTML(Search::getSearchPath($search), $search);
86 Nav::setSelected('search');
89 if (!empty($_GET['tag'])) {
91 $search = '#' . trim(rawurldecode($_GET['tag']));
94 // contruct a wrapper for the search header
95 $o = Renderer::replaceMacros(Renderer::getMarkupTemplate('content_wrapper.tpl'), [
96 'name' => 'search-header',
97 '$title' => DI::l10n()->t('Search'),
99 '$content' => HTML::search($search, 'search-box', false)
106 if (strpos($search, '#') === 0) {
108 $search = substr($search, 1);
111 self::tryRedirectToProfile($search);
113 if (strpos($search, '@') === 0 || strpos($search, '!') === 0) {
114 return self::performContactSearch($search);
117 self::tryRedirectToPost($search);
119 if (!empty($_GET['search-option'])) {
120 switch ($_GET['search-option']) {
127 return self::performContactSearch($search, '@');
129 return self::performContactSearch($search, '!');
133 // Don't perform a fulltext or tag search on search results that look like an URL
134 // Tags don't look like an URL and the fulltext search does only work with natural words
135 if (parse_url($search, PHP_URL_SCHEME) && parse_url($search, PHP_URL_HOST)) {
136 Logger::info('Skipping tag and fulltext search since the search looks like a URL.', ['q' => $search]);
137 notice(DI::l10n()->t('No results.'));
141 $tag = $tag || DI::config()->get('system', 'only_tag_search');
143 // Here is the way permissions work in the search module...
144 // Only public posts can be shown
145 // OR your own posts if you are a logged in member
146 // No items will be shown if the member has a blocked profile wall.
148 if (DI::mode()->isMobile()) {
149 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
150 DI::config()->get('system', 'itemspage_network_mobile'));
152 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
153 DI::config()->get('system', 'itemspage_network'));
156 $last_uriid = isset($_GET['last_uriid']) ? intval($_GET['last_uriid']) : 0;
158 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
161 Logger::info('Start tag search.', ['q' => $search]);
162 $uriids = Tag::getURIIdListByTag($search, local_user(), $pager->getStart(), $pager->getItemsPerPage(), $last_uriid);
163 $count = Tag::countByTag($search, local_user());
165 Logger::info('Start fulltext search.', ['q' => $search]);
166 $uriids = Post\Content::getURIIdListBySearch($search, local_user(), $pager->getStart(), $pager->getItemsPerPage(), $last_uriid);
167 $count = Post\Content::countBySearch($search, local_user());
170 if (!empty($uriids)) {
171 $condition = ["(`uid` = ? OR (`uid` = ? AND NOT `global`))", 0, local_user()];
172 $condition = DBA::mergeConditions($condition, ['uri-id' => $uriids]);
173 $params = ['order' => ['id' => true]];
174 $items = Post::toArray(Post::selectForUser(local_user(), Item::DISPLAY_FIELDLIST, $condition, $params));
178 if (empty($last_uriid)) {
179 notice(DI::l10n()->t('No results.'));
184 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
185 $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
186 $o .= Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
190 $title = DI::l10n()->t('Items tagged with: %s', $search);
192 $title = DI::l10n()->t('Results for: %s', $search);
195 $o .= Renderer::replaceMacros(Renderer::getMarkupTemplate('section_title.tpl'), [
199 Logger::info('Start Conversation.', ['q' => $search]);
201 $o .= DI::conversation()->create($items, 'search', false, false, 'commented', local_user());
203 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
204 $o .= HTML::scrollLoader();
206 $o .= $pager->renderMinimal($count);
214 * Tries to redirect to a local profile page based on the input.
216 * This method separates logged in and anonymous users. Logged in users can trigger contact probes to import
217 * non-existing contacts while anonymous users can only trigger a local lookup.
222 * - Any fully-formed URL
224 * @param string $search
225 * @throws HTTPException\InternalServerErrorException
226 * @throws \ImagickException
228 private static function tryRedirectToProfile(string $search)
230 $search = Network::convertToIdn($search);
231 $isUrl = !empty(parse_url($search, PHP_URL_SCHEME));
232 $isAddr = (bool)preg_match('/^@?([a-z0-9.-_]+@[a-z0-9.-_:]+)$/i', trim($search), $matches);
234 if (!$isUrl && !$isAddr) {
239 $search = $matches[1];
243 // User-specific contact URL/address search
244 $contact_id = Contact::getIdForURL($search, local_user());
246 // User-specific contact URL/address search and probe
247 $contact_id = Contact::getIdForURL($search);
250 // Cheaper local lookup for anonymous users, no probe
252 $contact = Contact::selectFirst(['id'], ['addr' => $search, 'uid' => 0]);
254 $contact = Contact::getByURL($search, null, ['id']) ?: ['id' => 0];
257 if (DBA::isResult($contact)) {
258 $contact_id = $contact['id'];
262 if (!empty($contact_id)) {
263 DI::baseUrl()->redirect('contact/' . $contact_id);
268 * Fetch/search a post by URL and redirects to its local representation if it was found.
270 * @param string $search
271 * @throws HTTPException\InternalServerErrorException
273 private static function tryRedirectToPost(string $search)
275 if (parse_url($search, PHP_URL_SCHEME) == '') {
279 $search = Network::convertToIdn($search);
283 $item_id = Item::fetchByLink($search, local_user());
285 // If the user-specific search failed, we search and probe a public post
286 $item_id = Item::fetchByLink($search);
289 // Cheaper local lookup for anonymous users, no probe
290 $item_id = Item::searchByLink($search);
293 if (!empty($item_id)) {
294 $item = Post::selectFirst(['guid'], ['id' => $item_id]);
295 if (DBA::isResult($item)) {
296 DI::baseUrl()->redirect('display/' . $item['guid']);