3 * @copyright Copyright (C) 2020, Friendica
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\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\ItemContent;
38 use Friendica\Model\Post;
39 use Friendica\Model\Tag;
40 use Friendica\Module\BaseSearch;
41 use Friendica\Network\HTTPException;
42 use Friendica\Util\Strings;
44 class Index extends BaseSearch
46 public static function content(array $parameters = [])
48 $search = (!empty($_GET['q']) ? Strings::escapeTags(trim(rawurldecode($_GET['q']))) : '');
50 if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) {
51 throw new HTTPException\ForbiddenException(DI::l10n()->t('Public access denied.'));
54 if (DI::config()->get('system', 'local_search') && !Session::isAuthenticated()) {
55 $e = new HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a search.'));
56 $e->httpdesc = DI::l10n()->t('Public access denied.');
60 if (DI::config()->get('system', 'permit_crawling') && !Session::isAuthenticated()) {
62 // 10 requests are "free", after the 11th only a call per minute is allowed
64 $free_crawls = intval(DI::config()->get('system', 'free_crawls'));
65 if ($free_crawls == 0)
68 $crawl_permit_period = intval(DI::config()->get('system', 'crawl_permit_period'));
69 if ($crawl_permit_period == 0)
70 $crawl_permit_period = 10;
72 $remote = $_SERVER['REMOTE_ADDR'];
73 $result = DI::cache()->get('remote_search:' . $remote);
74 if (!is_null($result)) {
75 $resultdata = json_decode($result);
76 if (($resultdata->time > (time() - $crawl_permit_period)) && ($resultdata->accesses > $free_crawls)) {
77 throw new HTTPException\TooManyRequestsException(DI::l10n()->t('Only one search per minute is permitted for not logged in users.'));
79 DI::cache()->set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => $resultdata->accesses + 1]), Duration::HOUR);
81 DI::cache()->set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => 1]), Duration::HOUR);
86 DI::page()['aside'] .= Widget\SavedSearches::getHTML(Search::getSearchPath($search), $search);
89 Nav::setSelected('search');
92 if (!empty($_GET['tag'])) {
94 $search = '#' . Strings::escapeTags(trim(rawurldecode($_GET['tag'])));
97 // contruct a wrapper for the search header
98 $o = Renderer::replaceMacros(Renderer::getMarkupTemplate('content_wrapper.tpl'), [
99 'name' => 'search-header',
100 '$title' => DI::l10n()->t('Search'),
102 '$content' => HTML::search($search, 'search-box', false)
109 if (strpos($search, '#') === 0) {
111 $search = substr($search, 1);
114 self::tryRedirectToProfile($search);
116 if (strpos($search, '@') === 0 || strpos($search, '!') === 0) {
117 return self::performContactSearch($search);
120 self::tryRedirectToPost($search);
122 if (!empty($_GET['search-option'])) {
123 switch ($_GET['search-option']) {
130 return self::performContactSearch($search, '@');
132 return self::performContactSearch($search, '!');
136 // Don't perform a fulltext or tag search on search results that look like an URL
137 // Tags don't look like an URL and the fulltext search does only work with natural words
138 if (parse_url($search, PHP_URL_SCHEME) && parse_url($search, PHP_URL_HOST)) {
139 Logger::info('Skipping tag and fulltext search since the search looks like a URL.', ['q' => $search]);
140 notice(DI::l10n()->t('No results.'));
144 $tag = $tag || DI::config()->get('system', 'only_tag_search');
146 // Here is the way permissions work in the search module...
147 // Only public posts can be shown
148 // OR your own posts if you are a logged in member
149 // No items will be shown if the member has a blocked profile wall.
151 if (DI::mode()->isMobile()) {
152 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
153 DI::config()->get('system', 'itemspage_network_mobile'));
155 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
156 DI::config()->get('system', 'itemspage_network'));
159 $last_uriid = isset($_GET['last_uriid']) ? intval($_GET['last_uriid']) : 0;
161 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
164 Logger::info('Start tag search.', ['q' => $search]);
165 $uriids = Tag::getURIIdListByTag($search, local_user(), $pager->getStart(), $pager->getItemsPerPage(), $last_uriid);
166 $count = Tag::countByTag($search, local_user());
168 Logger::info('Start fulltext search.', ['q' => $search]);
169 $uriids = Post\Content::getURIIdListBySearch($search, local_user(), $pager->getStart(), $pager->getItemsPerPage(), $last_uriid);
170 $count = Post\Content::countBySearch($search, local_user());
173 if (!empty($uriids)) {
174 $params = ['order' => ['id' => true], 'group_by' => ['uri-id']];
175 $items = Post::toArray(Post::selectForUser(local_user(), Item::DISPLAY_FIELDLIST, ['uri-id' => $uriids], $params));
179 if (empty($last_uriid)) {
180 notice(DI::l10n()->t('No results.'));
185 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
186 $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
187 $o .= Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
191 $title = DI::l10n()->t('Items tagged with: %s', $search);
193 $title = DI::l10n()->t('Results for: %s', $search);
196 $o .= Renderer::replaceMacros(Renderer::getMarkupTemplate('section_title.tpl'), [
200 Logger::info('Start Conversation.', ['q' => $search]);
202 $o .= conversation(DI::app(), $items, 'search', false, false, 'commented', local_user());
204 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
205 $o .= HTML::scrollLoader();
207 $o .= $pager->renderMinimal($count);
215 * Tries to redirect to a local profile page based on the input.
217 * This method separates logged in and anonymous users. Logged in users can trigger contact probes to import
218 * non-existing contacts while anonymous users can only trigger a local lookup.
223 * - Any fully-formed URL
225 * @param string $search
226 * @throws HTTPException\InternalServerErrorException
227 * @throws \ImagickException
229 private static function tryRedirectToProfile(string $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) == '') {
281 $item_id = Item::fetchByLink($search, local_user());
283 // If the user-specific search failed, we search and probe a public post
284 $item_id = Item::fetchByLink($search);
287 // Cheaper local lookup for anonymous users, no probe
288 $item_id = Item::searchByLink($search);
291 if (!empty($item_id)) {
292 $item = Post::selectFirst(['guid'], ['id' => $item_id]);
293 if (DBA::isResult($item)) {
294 DI::baseUrl()->redirect('display/' . $item['guid']);