src/Module/Search/Index.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, 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\Search;
  23
  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;
  34 use Friendica\DI;
  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\Strings;
  42
  43 class Index extends BaseSearch
  44 {
  45         public static function content(array $parameters = [])
  46         {
  47                 $search = (!empty($_GET['q']) ? Strings::escapeTags(trim(rawurldecode($_GET['q']))) : '');
  48
  49                 if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) {
  50                         throw new HTTPException\ForbiddenException(DI::l10n()->t('Public access denied.'));
  51                 }
  52
  53                 if (DI::config()->get('system', 'local_search') && !Session::isAuthenticated()) {
  54                         $e = new HTTPException\ForbiddenException(DI::l10n()->t('Only logged in users are permitted to perform a search.'));
  55                         $e->httpdesc = DI::l10n()->t('Public access denied.');
  56                         throw $e;
  57                 }
  58
  59                 if (DI::config()->get('system', 'permit_crawling') && !Session::isAuthenticated()) {
  60                         // Default values:
  61                         // 10 requests are "free", after the 11th only a call per minute is allowed
  62
  63                         $free_crawls = intval(DI::config()->get('system', 'free_crawls'));
  64                         if ($free_crawls == 0)
  65                                 $free_crawls = 10;
  66
  67                         $crawl_permit_period = intval(DI::config()->get('system', 'crawl_permit_period'));
  68                         if ($crawl_permit_period == 0)
  69                                 $crawl_permit_period = 10;
  70
  71                         $remote = $_SERVER['REMOTE_ADDR'];
  72                         $result = DI::cache()->get('remote_search:' . $remote);
  73                         if (!is_null($result)) {
  74                                 $resultdata = json_decode($result);
  75                                 if (($resultdata->time > (time() - $crawl_permit_period)) && ($resultdata->accesses > $free_crawls)) {
  76                                         throw new HTTPException\TooManyRequestsException(DI::l10n()->t('Only one search per minute is permitted for not logged in users.'));
  77                                 }
  78                                 DI::cache()->set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => $resultdata->accesses + 1]), Duration::HOUR);
  79                         } else {
  80                                 DI::cache()->set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => 1]), Duration::HOUR);
  81                         }
  82                 }
  83
  84                 if (local_user()) {
  85                         DI::page()['aside'] .= Widget\SavedSearches::getHTML(Search::getSearchPath($search), $search);
  86                 }
  87
  88                 Nav::setSelected('search');
  89
  90                 $tag = false;
  91                 if (!empty($_GET['tag'])) {
  92                         $tag = true;
  93                         $search = '#' . Strings::escapeTags(trim(rawurldecode($_GET['tag'])));
  94                 }
  95
  96                 // contruct a wrapper for the search header
  97                 $o = Renderer::replaceMacros(Renderer::getMarkupTemplate('content_wrapper.tpl'), [
  98                         'name' => 'search-header',
  99                         '$title' => DI::l10n()->t('Search'),
 100                         '$title_size' => 3,
 101                         '$content' => HTML::search($search, 'search-box', false)
 102                 ]);
 103
 104                 if (!$search) {
 105                         return $o;
 106                 }
 107
 108                 if (strpos($search, '#') === 0) {
 109                         $tag = true;
 110                         $search = substr($search, 1);
 111                 }
 112
 113                 self::tryRedirectToProfile($search);
 114
 115                 if (strpos($search, '@') === 0 || strpos($search, '!') === 0) {
 116                         return self::performContactSearch($search);
 117                 }
 118
 119                 self::tryRedirectToPost($search);
 120
 121                 if (!empty($_GET['search-option'])) {
 122                         switch ($_GET['search-option']) {
 123                                 case 'fulltext':
 124                                         break;
 125                                 case 'tags':
 126                                         $tag = true;
 127                                         break;
 128                                 case 'contacts':
 129                                         return self::performContactSearch($search, '@');
 130                                 case 'forums':
 131                                         return self::performContactSearch($search, '!');
 132                         }
 133                 }
 134
 135                 // Don't perform a fulltext or tag search on search results that look like an URL
 136                 // Tags don't look like an URL and the fulltext search does only work with natural words
 137                 if (parse_url($search, PHP_URL_SCHEME) && parse_url($search, PHP_URL_HOST)) {
 138                         Logger::info('Skipping tag and fulltext search since the search looks like a URL.', ['q' => $search]);
 139                         notice(DI::l10n()->t('No results.'));
 140                         return $o;
 141                 }
 142
 143                 $tag = $tag || DI::config()->get('system', 'only_tag_search');
 144
 145                 // Here is the way permissions work in the search module...
 146                 // Only public posts can be shown
 147                 // OR your own posts if you are a logged in member
 148                 // No items will be shown if the member has a blocked profile wall.
 149
 150                 if (DI::mode()->isMobile()) {
 151                         $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
 152                                 DI::config()->get('system', 'itemspage_network_mobile'));
 153                 } else {
 154                         $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
 155                                 DI::config()->get('system', 'itemspage_network'));
 156                 }
 157
 158                 $last_uriid = isset($_GET['last_uriid']) ? intval($_GET['last_uriid']) : 0;
 159
 160                 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
 161
 162                 if ($tag) {
 163                         Logger::info('Start tag search.', ['q' => $search]);
 164                         $uriids = Tag::getURIIdListByTag($search, local_user(), $pager->getStart(), $pager->getItemsPerPage(), $last_uriid);
 165                         $count = Tag::countByTag($search, local_user());
 166                 } else {
 167                         Logger::info('Start fulltext search.', ['q' => $search]);
 168                         $uriids = Post\Content::getURIIdListBySearch($search, local_user(), $pager->getStart(), $pager->getItemsPerPage(), $last_uriid);
 169                         $count = Post\Content::countBySearch($search, local_user());
 170                 }
 171
 172                 if (!empty($uriids)) {
 173                         $condition = ["(`uid` = ? OR (`uid` = ? AND NOT `global`))", 0, local_user()];
 174                         $condition = DBA::mergeConditions($condition, ['uri-id' => $uriids]);
 175                         $params = ['order' => ['id' => true]];
 176                         $items = Post::toArray(Post::selectForUser(local_user(), Item::DISPLAY_FIELDLIST, $condition, $params));
 177                 }
 178
 179                 if (empty($items)) {
 180                         if (empty($last_uriid)) {
 181                                 notice(DI::l10n()->t('No results.'));
 182                         }
 183                         return $o;
 184                 }
 185
 186                 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
 187                         $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
 188                         $o .= Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
 189                 }
 190
 191                 if ($tag) {
 192                         $title = DI::l10n()->t('Items tagged with: %s', $search);
 193                 } else {
 194                         $title = DI::l10n()->t('Results for: %s', $search);
 195                 }
 196
 197                 $o .= Renderer::replaceMacros(Renderer::getMarkupTemplate('section_title.tpl'), [
 198                         '$title' => $title
 199                 ]);
 200
 201                 Logger::info('Start Conversation.', ['q' => $search]);
 202
 203                 $o .= DI::conversation()->create($items, 'search', false, false, 'commented', local_user());
 204
 205                 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
 206                         $o .= HTML::scrollLoader();
 207                 } else {
 208                         $o .= $pager->renderMinimal($count);
 209                 }
 210
 211
 212                 return $o;
 213         }
 214
 215         /**
 216          * Tries to redirect to a local profile page based on the input.
 217          *
 218          * This method separates logged in and anonymous users. Logged in users can trigger contact probes to import
 219          * non-existing contacts while anonymous users can only trigger a local lookup.
 220          *
 221          * Formats matched:
 222          * - @user@domain
 223          * - user@domain
 224          * - Any fully-formed URL
 225          *
 226          * @param string  $search
 227          * @throws HTTPException\InternalServerErrorException
 228          * @throws \ImagickException
 229          */
 230         private static function tryRedirectToProfile(string $search)
 231         {
 232                 $isUrl = !empty(parse_url($search, PHP_URL_SCHEME));
 233                 $isAddr = (bool)preg_match('/^@?([a-z0-9.-_]+@[a-z0-9.-_:]+)$/i', trim($search), $matches);
 234
 235                 if (!$isUrl && !$isAddr) {
 236                         return;
 237                 }
 238
 239                 if ($isAddr) {
 240                         $search = $matches[1];
 241                 }
 242
 243                 if (local_user()) {
 244                         // User-specific contact URL/address search
 245                         $contact_id = Contact::getIdForURL($search, local_user());
 246                         if (!$contact_id) {
 247                                 // User-specific contact URL/address search and probe
 248                                 $contact_id = Contact::getIdForURL($search);
 249                         }
 250                 } else {
 251                         // Cheaper local lookup for anonymous users, no probe
 252                         if ($isAddr) {
 253                                 $contact = Contact::selectFirst(['id'], ['addr' => $search, 'uid' => 0]);
 254                         } else {
 255                                 $contact = Contact::getByURL($search, null, ['id']) ?: ['id' => 0];
 256                         }
 257
 258                         if (DBA::isResult($contact)) {
 259                                 $contact_id = $contact['id'];
 260                         }
 261                 }
 262
 263                 if (!empty($contact_id)) {
 264                         DI::baseUrl()->redirect('contact/' . $contact_id);
 265                 }
 266         }
 267
 268         /**
 269          * Fetch/search a post by URL and redirects to its local representation if it was found.
 270          *
 271          * @param string  $search
 272          * @throws HTTPException\InternalServerErrorException
 273          */
 274         private static function tryRedirectToPost(string $search)
 275         {
 276                 if (parse_url($search, PHP_URL_SCHEME) == '') {
 277                         return;
 278                 }
 279
 280                 if (local_user()) {
 281                         // Post URL search
 282                         $item_id = Item::fetchByLink($search, local_user());
 283                         if (!$item_id) {
 284                                 // If the user-specific search failed, we search and probe a public post
 285                                 $item_id = Item::fetchByLink($search);
 286                         }
 287                 } else {
 288                         // Cheaper local lookup for anonymous users, no probe
 289                         $item_id = Item::searchByLink($search);
 290                 }
 291
 292                 if (!empty($item_id)) {
 293                         $item = Post::selectFirst(['guid'], ['id' => $item_id]);
 294                         if (DBA::isResult($item)) {
 295                                 DI::baseUrl()->redirect('display/' . $item['guid']);
 296                         }
 297                 }
 298         }
 299 }