src/Core/Search.php

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