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\Session;
32 use Friendica\Database\DBA;
34 use Friendica\Model\Contact;
35 use Friendica\Model\Item;
36 use Friendica\Model\Tag;
37 use Friendica\Model\Term;
38 use Friendica\Module\BaseSearch;
39 use Friendica\Network\HTTPException;
40 use Friendica\Util\Strings;
42 class Index extends BaseSearch
44 public static function content(array $parameters = [])
46 $search = (!empty($_GET['q']) ? Strings::escapeTags(trim(rawurldecode($_GET['q']))) : '');
48 if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) {
49 throw new HTTPException\ForbiddenException(DI::l10n()->t('Public access denied.'));
52 if (DI::config()->get('system', 'local_search') && !Session::isAuthenticated()) {
53 $e = new HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a search.'));
54 $e->httpdesc = DI::l10n()->t('Public access denied.');
58 if (DI::config()->get('system', 'permit_crawling') && !Session::isAuthenticated()) {
60 // 10 requests are "free", after the 11th only a call per minute is allowed
62 $free_crawls = intval(DI::config()->get('system', 'free_crawls'));
63 if ($free_crawls == 0)
66 $crawl_permit_period = intval(DI::config()->get('system', 'crawl_permit_period'));
67 if ($crawl_permit_period == 0)
68 $crawl_permit_period = 10;
70 $remote = $_SERVER['REMOTE_ADDR'];
71 $result = DI::cache()->get('remote_search:' . $remote);
72 if (!is_null($result)) {
73 $resultdata = json_decode($result);
74 if (($resultdata->time > (time() - $crawl_permit_period)) && ($resultdata->accesses > $free_crawls)) {
75 throw new HTTPException\TooManyRequestsException(DI::l10n()->t('Only one search per minute is permitted for not logged in users.'));
77 DI::cache()->set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => $resultdata->accesses + 1]), Duration::HOUR);
79 DI::cache()->set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => 1]), Duration::HOUR);
84 DI::page()['aside'] .= Widget\SavedSearches::getHTML('search?q=' . urlencode($search), $search);
87 Nav::setSelected('search');
90 if (!empty($_GET['tag'])) {
92 $search = '#' . Strings::escapeTags(trim(rawurldecode($_GET['tag'])));
95 // contruct a wrapper for the search header
96 $o = Renderer::replaceMacros(Renderer::getMarkupTemplate('content_wrapper.tpl'), [
97 'name' => 'search-header',
98 '$title' => DI::l10n()->t('Search'),
100 '$content' => HTML::search($search, 'search-box', false)
107 if (strpos($search, '#') === 0) {
109 $search = substr($search, 1);
112 self::tryRedirectToProfile($search);
114 if (strpos($search, '@') === 0 || strpos($search, '!') === 0) {
115 return self::performContactSearch($search);
118 self::tryRedirectToPost($search);
120 if (!empty($_GET['search-option'])) {
121 switch ($_GET['search-option']) {
128 return self::performContactSearch($search, '@');
130 return self::performContactSearch($search, '!');
134 $tag = $tag || DI::config()->get('system', 'only_tag_search');
136 // Here is the way permissions work in the search module...
137 // Only public posts can be shown
138 // OR your own posts if you are a logged in member
139 // No items will be shown if the member has a blocked profile wall.
141 if (DI::mode()->isMobile()) {
142 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
143 DI::config()->get('system', 'itemspage_network_mobile'));
145 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
146 DI::config()->get('system', 'itemspage_network'));
149 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
152 Logger::info('Start tag search.', ['q' => $search]);
155 "(`uid` = 0 OR (`uid` = ? AND NOT `global`))
156 AND `otype` = ? AND `type` = ? AND `term` = ?",
157 local_user(), Term::OBJECT_TYPE_POST, Tag::HASHTAG, $search
160 'order' => ['received' => true],
161 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]
163 $terms = DBA::select('term', ['oid'], $condition, $params);
166 while ($term = DBA::fetch($terms)) {
167 $itemids[] = $term['oid'];
172 if (!empty($itemids)) {
173 $params = ['order' => ['id' => true]];
174 $items = Item::selectForUser(local_user(), [], ['id' => $itemids], $params);
175 $r = Item::inArray($items);
180 Logger::info('Start fulltext search.', ['q' => $search]);
183 "(`uid` = 0 OR (`uid` = ? AND NOT `global`))
184 AND `body` LIKE CONCAT('%',?,'%')",
185 local_user(), $search
188 'order' => ['id' => true],
189 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]
191 $items = Item::selectForUser(local_user(), [], $condition, $params);
192 $r = Item::inArray($items);
195 if (!DBA::isResult($r)) {
196 info(DI::l10n()->t('No results.'));
201 $title = DI::l10n()->t('Items tagged with: %s', $search);
203 $title = DI::l10n()->t('Results for: %s', $search);
206 $o .= Renderer::replaceMacros(Renderer::getMarkupTemplate('section_title.tpl'), [
210 Logger::info('Start Conversation.', ['q' => $search]);
212 $o .= conversation(DI::app(), $r, 'search', false, false, 'commented', local_user());
214 $o .= $pager->renderMinimal(count($r));
220 * Tries to redirect to a local profile page based on the input.
222 * This method separates logged in and anonymous users. Logged in users can trigger contact probes to import
223 * non-existing contacts while anonymous users can only trigger a local lookup.
228 * - Any fully-formed URL
230 * @param string $search
231 * @throws HTTPException\InternalServerErrorException
232 * @throws \ImagickException
234 private static function tryRedirectToProfile(string $search)
236 $isUrl = !empty(parse_url($search, PHP_URL_SCHEME));
237 $isAddr = (bool)preg_match('/^@?([a-z0-9.-_]+@[a-z0-9.-_:]+)$/i', trim($search), $matches);
239 if (!$isUrl && !$isAddr) {
244 $search = $matches[1];
248 // User-specific contact URL/address search
249 $contact_id = Contact::getIdForURL($search, local_user());
251 // User-specific contact URL/address search and probe
252 $contact_id = Contact::getIdForURL($search);
255 // Cheaper local lookup for anonymous users, no probe
257 $contact = Contact::selectFirst(['id' => 'cid'], ['addr' => $search, 'uid' => 0]);
259 $contact = Contact::getDetailsByURL($search, 0, ['cid' => 0]);
262 if (DBA::isResult($contact)) {
263 $contact_id = $contact['cid'];
267 if (!empty($contact_id)) {
268 DI::baseUrl()->redirect('contact/' . $contact_id);
273 * Fetch/search a post by URL and redirects to its local representation if it was found.
275 * @param string $search
276 * @throws HTTPException\InternalServerErrorException
278 private static function tryRedirectToPost(string $search)
280 if (parse_url($search, PHP_URL_SCHEME) == '') {
286 $item_id = Item::fetchByLink($search, local_user());
288 // If the user-specific search failed, we search and probe a public post
289 $item_id = Item::fetchByLink($search);
292 // Cheaper local lookup for anonymous users, no probe
293 $item_id = Item::searchByLink($search);
296 if (!empty($item_id)) {
297 $item = Item::selectFirst(['guid'], ['id' => $item_id]);
298 if (DBA::isResult($item)) {
299 DI::baseUrl()->redirect('display/' . $item['guid']);