src/Core/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\Core;
  23
  24 use Friendica\DI;
  25 use Friendica\Model\Contact;
  26 use Friendica\Network\HTTPClient\Client\HttpClient;
  27 use Friendica\Network\HTTPException;
  28 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
  29 use Friendica\Object\Search\ContactResult;
  30 use Friendica\Object\Search\ResultList;
  31 use Friendica\Util\Network;
  32 use Friendica\Util\Strings;
  33
  34 /**
  35  * Specific class to perform searches for different systems. Currently:
  36  * - Probe for contacts
  37  * - Search in the local directory
  38  * - Search in the global directory
  39  */
  40 class Search
  41 {
  42         const DEFAULT_DIRECTORY = 'https://dir.friendica.social';
  43
  44         const TYPE_PEOPLE = 0;
  45         const TYPE_FORUM  = 1;
  46         const TYPE_ALL    = 2;
  47
  48         /**
  49          * Search a user based on his/her profile address
  50          * pattern: @username@domain.tld
  51          *
  52          * @param string $user The user to search for
  53          *
  54          * @return ResultList
  55          * @throws HTTPException\InternalServerErrorException
  56          * @throws \ImagickException
  57          */
  58         public static function getContactsFromProbe($user)
  59         {
  60                 $emptyResultList = new ResultList(1, 0, 1);
  61
  62                 if ((filter_var($user, FILTER_VALIDATE_EMAIL) && Network::isEmailDomainValid($user)) ||
  63                     (substr(Strings::normaliseLink($user), 0, 7) == "http://")) {
  64
  65                         $user_data = Contact::getByURL($user);
  66                         if (empty($user_data)) {
  67                                 return $emptyResultList;
  68                         }
  69
  70                         if (!in_array($user_data["network"], Protocol::FEDERATED)) {
  71                                 return $emptyResultList;
  72                         }
  73
  74                         $contactDetails = Contact::getByURLForUser($user_data['url'] ?? '', local_user());
  75
  76                         $result = new ContactResult(
  77                                 $user_data['name'] ?? '',
  78                                 $user_data['addr'] ?? '',
  79                                 ($contactDetails['addr'] ?? '') ?: ($user_data['url'] ?? ''),
  80                                 $user_data['url'] ?? '',
  81                                 $user_data['photo'] ?? '',
  82                                 $user_data['network'] ?? '',
  83                                 $contactDetails['id'] ?? 0,
  84                                 $user_data['id'] ?? 0,
  85                                 $user_data['tags'] ?? ''
  86                         );
  87
  88                         return new ResultList(1, 1, 1, [$result]);
  89                 } else {
  90                         return $emptyResultList;
  91                 }
  92         }
  93
  94         /**
  95          * Search in the global directory for occurrences of the search string
  96          *
  97          * @see https://github.com/friendica/friendica-directory/blob/stable/docs/Protocol.md#search
  98          *
  99          * @param string $search
 100          * @param int    $type specific type of searching
 101          * @param int    $page
 102          *
 103          * @return ResultList
 104          * @throws HTTPException\InternalServerErrorException
 105          */
 106         public static function getContactsFromGlobalDirectory($search, $type = self::TYPE_ALL, $page = 1)
 107         {
 108                 $server = DI::config()->get('system', 'directory', self::DEFAULT_DIRECTORY);
 109
 110                 $searchUrl = $server . '/search';
 111
 112                 switch ($type) {
 113                         case self::TYPE_FORUM:
 114                                 $searchUrl .= '/forum';
 115                                 break;
 116                         case self::TYPE_PEOPLE:
 117                                 $searchUrl .= '/people';
 118                                 break;
 119                 }
 120                 $searchUrl .= '?q=' . urlencode($search);
 121
 122                 if ($page > 1) {
 123                         $searchUrl .= '&page=' . $page;
 124                 }
 125
 126                 $resultJson = DI::httpClient()->fetch($searchUrl, 0, HttpClient::ACCEPT_JSON);
 127
 128                 $results = json_decode($resultJson, true);
 129
 130                 $resultList = new ResultList(
 131                         ($results['page']         ?? 0) ?: 1,
 132                          $results['count']        ?? 0,
 133                         ($results['itemsperpage'] ?? 0) ?: 30
 134                 );
 135
 136                 $profiles = $results['profiles'] ?? [];
 137
 138                 foreach ($profiles as $profile) {
 139                         $profile_url = $profile['profile_url'] ?? '';
 140                         $contactDetails = Contact::getByURLForUser($profile_url, local_user());
 141
 142                         $result = new ContactResult(
 143                                 $profile['name'] ?? '',
 144                                 $profile['addr'] ?? '',
 145                                 ($contactDetails['addr'] ?? '') ?: $profile_url,
 146                                 $profile_url,
 147                                 $profile['photo'] ?? '',
 148                                 Protocol::DFRN,
 149                                 $contactDetails['cid'] ?? 0,
 150                                 0,
 151                                 $profile['tags'] ?? ''
 152                         );
 153
 154                         $resultList->addResult($result);
 155                 }
 156
 157                 return $resultList;
 158         }
 159
 160         /**
 161          * Search in the local database for occurrences of the search string
 162          *
 163          * @param string $search
 164          * @param int    $type
 165          * @param int    $start
 166          * @param int    $itemPage
 167          *
 168          * @return ResultList
 169          * @throws HTTPException\InternalServerErrorException
 170          */
 171         public static function getContactsFromLocalDirectory($search, $type = self::TYPE_ALL, $start = 0, $itemPage = 80)
 172         {
 173                 Logger::info('Searching', ['search' => $search, 'type' => $type, 'start' => $start, 'itempage' => $itemPage]);
 174
 175                 $contacts = Contact::searchByName($search, $type == self::TYPE_FORUM ? 'community' : '');
 176
 177                 $resultList = new ResultList($start, $itemPage, count($contacts));
 178
 179                 foreach ($contacts as $contact) {
 180                         $result = new ContactResult(
 181                                 $contact["name"],
 182                                 $contact["addr"],
 183                                 $contact["addr"],
 184                                 $contact["url"],
 185                                 $contact["photo"],
 186                                 $contact["network"],
 187                                 $contact["cid"] ?? 0,
 188                                 $contact["zid"] ?? 0,
 189                                 $contact["keywords"]
 190                         );
 191
 192                         $resultList->addResult($result);
 193                 }
 194
 195                 // Add found profiles from the global directory to the local directory
 196                 Worker::add(PRIORITY_LOW, 'SearchDirectory', $search);
 197
 198                 return $resultList;
 199         }
 200
 201         /**
 202          * Searching for contacts for autocompletion
 203          *
 204          * @param string $search Name or part of a name or nick
 205          * @param string $mode   Search mode (e.g. "community")
 206          * @param int    $page   Page number (starts at 1)
 207          * @return array with the search results
 208          * @throws HTTPException\InternalServerErrorException
 209          */
 210         public static function searchContact($search, $mode, int $page = 1)
 211         {
 212                 Logger::info('Searching', ['search' => $search, 'mode' => $mode, 'page' => $page]);
 213
 214                 if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) {
 215                         return [];
 216                 }
 217
 218                 // don't search if search term has less than 2 characters
 219                 if (!$search || mb_strlen($search) < 2) {
 220                         return [];
 221                 }
 222
 223                 if (substr($search, 0, 1) === '@') {
 224                         $search = substr($search, 1);
 225                 }
 226
 227                 // check if searching in the local global contact table is enabled
 228                 if (DI::config()->get('system', 'poco_local_search')) {
 229                         $return = Contact::searchByName($search, $mode);
 230                 } else {
 231                         $p = $page > 1 ? 'p=' . $page : '';
 232                         $curlResult = DI::httpClient()->get(self::getGlobalDirectory() . '/search/people?' . $p . '&q=' . urlencode($search), [HttpClientOptions::ACCEPT_CONTENT => HttpClient::ACCEPT_JSON]);
 233                         if ($curlResult->isSuccess()) {
 234                                 $searchResult = json_decode($curlResult->getBody(), true);
 235                                 if (!empty($searchResult['profiles'])) {
 236                                         $return = $searchResult['profiles'];
 237                                 }
 238                         }
 239                 }
 240
 241                 return $return ?? [];
 242         }
 243
 244         /**
 245          * Returns the global directory name, used in this node
 246          *
 247          * @return string
 248          */
 249         public static function getGlobalDirectory()
 250         {
 251                 return DI::config()->get('system', 'directory', self::DEFAULT_DIRECTORY);
 252         }
 253
 254         /**
 255          * Return the search path (either fulltext search or tag search)
 256          *
 257          * @param string $search
 258          * @return string search path
 259          */
 260         public static function getSearchPath(string $search)
 261         {
 262                 if (substr($search, 0, 1) == '#') {
 263                         return 'search?tag=' . urlencode(substr($search, 1));
 264                 } else {
 265                         return 'search?q=' . urlencode($search);
 266                 }
 267         }
 268 }