3 namespace Friendica\Core;
5 use Friendica\Database\DBA;
7 use Friendica\Model\Contact;
8 use Friendica\Model\GContact;
9 use Friendica\Network\HTTPException;
10 use Friendica\Network\Probe;
11 use Friendica\Object\Search\ContactResult;
12 use Friendica\Object\Search\ResultList;
13 use Friendica\Protocol\PortableContact;
14 use Friendica\Util\Network;
15 use Friendica\Util\Strings;
18 * Specific class to perform searches for different systems. Currently:
19 * - Probe for contacts
20 * - Search in the local directory
21 * - Search in the global directory
25 const DEFAULT_DIRECTORY = 'https://dir.friendica.social';
27 const TYPE_PEOPLE = 0;
32 * Search a user based on his/her profile address
33 * pattern: @username@domain.tld
35 * @param string $user The user to search for
38 * @throws HTTPException\InternalServerErrorException
39 * @throws \ImagickException
41 public static function getContactsFromProbe($user)
43 $emptyResultList = new ResultList(1, 0, 1);
45 if ((filter_var($user, FILTER_VALIDATE_EMAIL) && Network::isEmailDomainValid($user)) ||
46 (substr(Strings::normaliseLink($user), 0, 7) == "http://")) {
48 /// @todo Possibly use "getIdForURL" instead?
49 $user_data = Probe::uri($user);
50 if (empty($user_data)) {
51 return $emptyResultList;
54 if (!in_array($user_data["network"], Protocol::FEDERATED)) {
55 return $emptyResultList;
58 // Ensure that we do have a contact entry
59 Contact::getIdForURL($user_data['url'] ?? '');
61 $contactDetails = Contact::getDetailsByURL($user_data['url'] ?? '', local_user());
63 $result = new ContactResult(
64 $user_data['name'] ?? '',
65 $user_data['addr'] ?? '',
66 ($contactDetails['addr'] ?? '') ?: ($user_data['url'] ?? ''),
67 $user_data['url'] ?? '',
68 $user_data['photo'] ?? '',
69 $user_data['network'] ?? '',
70 $contactDetails['id'] ?? 0,
72 $user_data['tags'] ?? ''
75 return new ResultList(1, 1, 1, [$result]);
77 return $emptyResultList;
82 * Search in the global directory for occurrences of the search string
84 * @see https://github.com/friendica/friendica-directory/blob/master/docs/Protocol.md#search
86 * @param string $search
87 * @param int $type specific type of searching
91 * @throws HTTPException\InternalServerErrorException
93 public static function getContactsFromGlobalDirectory($search, $type = self::TYPE_ALL, $page = 1)
95 $server = DI::config()->get('system', 'directory', self::DEFAULT_DIRECTORY);
97 $searchUrl = $server . '/search';
100 case self::TYPE_FORUM:
101 $searchUrl .= '/forum';
103 case self::TYPE_PEOPLE:
104 $searchUrl .= '/people';
107 $searchUrl .= '?q=' . urlencode($search);
110 $searchUrl .= '&page=' . $page;
113 $resultJson = Network::fetchUrl($searchUrl, false, 0, 'application/json');
115 $results = json_decode($resultJson, true);
117 $resultList = new ResultList(
118 ($results['page'] ?? 0) ?: 1,
119 $results['count'] ?? 0,
120 ($results['itemsperpage'] ?? 0) ?: 30
123 $profiles = $results['profiles'] ?? [];
125 foreach ($profiles as $profile) {
126 $profile_url = $profile['profile_url'] ?? '';
127 $contactDetails = Contact::getDetailsByURL($profile_url, local_user());
129 $result = new ContactResult(
130 $profile['name'] ?? '',
131 $profile['addr'] ?? '',
132 ($contactDetails['addr'] ?? '') ?: $profile_url,
134 $profile['photo'] ?? '',
136 $contactDetails['cid'] ?? 0,
138 $profile['tags'] ?? ''
141 $resultList->addResult($result);
148 * Search in the local database for occurrences of the search string
150 * @param string $search
153 * @param int $itemPage
156 * @throws HTTPException\InternalServerErrorException
158 public static function getContactsFromLocalDirectory($search, $type = self::TYPE_ALL, $start = 0, $itemPage = 80)
160 $config = DI::config();
162 $diaspora = $config->get('system', 'diaspora_enabled') ? Protocol::DIASPORA : Protocol::DFRN;
163 $ostatus = !$config->get('system', 'ostatus_disabled') ? Protocol::OSTATUS : Protocol::DFRN;
165 $wildcard = Strings::escapeHtml('%' . $search . '%');
167 $count = DBA::count('gcontact', [
169 AND `network` IN (?, ?, ?, ?)
170 AND ((`last_contact` >= `last_failure`) OR (`updated` >= `last_failure`))
171 AND (`url` LIKE ? OR `name` LIKE ? OR `location` LIKE ?
172 OR `addr` LIKE ? OR `about` LIKE ? OR `keywords` LIKE ?)
173 AND `community` = ?',
174 Protocol::ACTIVITYPUB, Protocol::DFRN, $ostatus, $diaspora,
175 $wildcard, $wildcard, $wildcard,
176 $wildcard, $wildcard, $wildcard,
177 ($type === self::TYPE_FORUM),
180 $resultList = new ResultList($start, $itemPage, $count);
186 $data = DBA::select('gcontact', ['nurl'], [
188 AND `network` IN (?, ?, ?, ?)
189 AND ((`last_contact` >= `last_failure`) OR (`updated` >= `last_failure`))
190 AND (`url` LIKE ? OR `name` LIKE ? OR `location` LIKE ?
191 OR `addr` LIKE ? OR `about` LIKE ? OR `keywords` LIKE ?)
192 AND `community` = ?',
193 Protocol::ACTIVITYPUB, Protocol::DFRN, $ostatus, $diaspora,
194 $wildcard, $wildcard, $wildcard,
195 $wildcard, $wildcard, $wildcard,
196 ($type === self::TYPE_FORUM),
198 'group_by' => ['nurl', 'updated'],
199 'limit' => [$start, $itemPage],
200 'order' => ['updated' => 'DESC']
203 if (!DBA::isResult($data)) {
207 while ($row = DBA::fetch($data)) {
208 $urlParts = parse_url($row["nurl"]);
210 // Ignore results that look strange.
211 // For historic reasons the gcontact table does contain some garbage.
212 if (!empty($urlParts['query']) || !empty($urlParts['fragment'])) {
216 $contact = Contact::getDetailsByURL($row["nurl"], local_user());
218 if ($contact["name"] == "") {
219 $contact["name"] = end(explode("/", $urlParts["path"]));
222 $result = new ContactResult(
234 $resultList->addResult($result);
239 // Add found profiles from the global directory to the local directory
240 Worker::add(PRIORITY_LOW, 'SearchDirectory', $search);
246 * Searching for global contacts for autocompletion
248 * @param string $search Name or part of a name or nick
249 * @param string $mode Search mode (e.g. "community")
250 * @param int $page Page number (starts at 1)
251 * @return array with the search results
252 * @throws HTTPException\InternalServerErrorException
254 public static function searchGlobalContact($search, $mode, int $page = 1)
256 if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) {
260 // don't search if search term has less than 2 characters
261 if (!$search || mb_strlen($search) < 2) {
265 if (substr($search, 0, 1) === '@') {
266 $search = substr($search, 1);
269 // check if searching in the local global contact table is enabled
270 if (DI::config()->get('system', 'poco_local_search')) {
271 $return = GContact::searchByName($search, $mode);
273 $p = $page > 1 ? 'p=' . $page : '';
274 $curlResult = Network::curl(self::getGlobalDirectory() . '/search/people?' . $p . '&q=' . urlencode($search), false, ['accept_content' => 'application/json']);
275 if ($curlResult->isSuccess()) {
276 $searchResult = json_decode($curlResult->getBody(), true);
277 if (!empty($searchResult['profiles'])) {
278 $return = $searchResult['profiles'];
283 return $return ?? [];
287 * Returns the global directory name, used in this node
291 public static function getGlobalDirectory()
293 return DI::config()->get('system', 'directory', self::DEFAULT_DIRECTORY);