<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
namespace Friendica\Core;
-use Friendica\BaseObject;
-use Friendica\Database\DBA;
+use Friendica\DI;
use Friendica\Model\Contact;
-use Friendica\Network\Probe;
+use Friendica\Network\HTTPClient\Client\HttpClientAccept;
use Friendica\Network\HTTPException;
use Friendica\Object\Search\ContactResult;
use Friendica\Object\Search\ResultList;
-use Friendica\Protocol\PortableContact;
use Friendica\Util\Network;
use Friendica\Util\Strings;
-class Search extends BaseObject
+/**
+ * Specific class to perform searches for different systems. Currently:
+ * - Probe for contacts
+ * - Search in the local directory
+ * - Search in the global directory
+ */
+class Search
{
const DEFAULT_DIRECTORY = 'https://dir.friendica.social';
+ const TYPE_PEOPLE = 0;
+ const TYPE_FORUM = 1;
+ const TYPE_ALL = 2;
+
/**
* Search a user based on his/her profile address
* pattern: @username@domain.tld
*
* @param string $user The user to search for
*
- * @return ResultList|null
+ * @return ResultList
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function getContactsFromProbe($user)
{
+ $emptyResultList = new ResultList(1, 0, 1);
+
if ((filter_var($user, FILTER_VALIDATE_EMAIL) && Network::isEmailDomainValid($user)) ||
(substr(Strings::normaliseLink($user), 0, 7) == "http://")) {
- $user_data = Probe::uri($user);
+ $user_data = Contact::getByURL($user);
if (empty($user_data)) {
- return null;
+ return $emptyResultList;
}
- if (!(in_array($user_data["network"], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::OSTATUS, Protocol::DIASPORA]))) {
- return null;
+ if (!in_array($user_data["network"], Protocol::FEDERATED)) {
+ return $emptyResultList;
}
- $contactDetails = Contact::getDetailsByURL(defaults($user_data, 'url', ''), local_user());
- $itemUrl = (($contactDetails["addr"] != "") ? $contactDetails["addr"] : defaults($user_data, 'url', ''));
+ $contactDetails = Contact::getByURLForUser($user_data['url'] ?? '', local_user());
$result = new ContactResult(
- defaults($user_data, 'name', ''),
- defaults($user_data, 'addr', ''),
- $itemUrl,
- defaults($user_data, 'url', ''),
- defaults($user_data, 'photo', ''),
- defaults($user_data, 'network', ''),
- defaults($contactDetails, 'cid', 0),
- 0,
- defaults($user_data, 'tags', '')
+ $user_data['name'] ?? '',
+ $user_data['addr'] ?? '',
+ ($contactDetails['addr'] ?? '') ?: ($user_data['url'] ?? ''),
+ $user_data['url'] ?? '',
+ $user_data['photo'] ?? '',
+ $user_data['network'] ?? '',
+ $contactDetails['id'] ?? 0,
+ $user_data['id'] ?? 0,
+ $user_data['tags'] ?? ''
);
return new ResultList(1, 1, 1, [$result]);
-
} else {
- return null;
+ return $emptyResultList;
}
}
/**
* Search in the global directory for occurrences of the search string
- * This is mainly based on the JSON results of https://dir.friendica.social
+ *
+ * @see https://github.com/friendica/friendica-directory/blob/stable/docs/Protocol.md#search
*
* @param string $search
+ * @param int $type specific type of searching
* @param int $page
*
- * @return ResultList|null
+ * @return ResultList
* @throws HTTPException\InternalServerErrorException
*/
- public static function getContactsFromGlobalDirectory($search, $page = 1)
+ public static function getContactsFromGlobalDirectory($search, $type = self::TYPE_ALL, $page = 1)
{
- $config = self::getApp()->getConfig();
- $server = $config->get('system', 'directory', self::DEFAULT_DIRECTORY);
+ $server = self::getGlobalDirectory();
+
+ $searchUrl = $server . '/search';
- $searchUrl = $server . '/search?q=' . urlencode($search);
+ switch ($type) {
+ case self::TYPE_FORUM:
+ $searchUrl .= '/forum';
+ break;
+ case self::TYPE_PEOPLE:
+ $searchUrl .= '/people';
+ break;
+ }
+ $searchUrl .= '?q=' . urlencode($search);
if ($page > 1) {
$searchUrl .= '&page=' . $page;
}
- $red = 0;
- $resultJson = Network::fetchUrl($searchUrl, false,$red, 0, 'application/json');
+ $resultJson = DI::httpClient()->fetch($searchUrl, HttpClientAccept::JSON);
- $results = json_decode($resultJson, true);
+ $results = json_decode($resultJson, true);
$resultList = new ResultList(
- defaults($results, 'page', 1),
- defaults($results, 'count', 1),
- defaults($results, 'itemsperpage', 1)
+ ($results['page'] ?? 0) ?: 1,
+ $results['count'] ?? 0,
+ ($results['itemsperpage'] ?? 0) ?: 30
);
- $profiles = defaults($results, 'profiles', []);
+ $profiles = $results['profiles'] ?? [];
foreach ($profiles as $profile) {
- $contactDetails = Contact::getDetailsByURL(defaults($profile, 'profile_url', ''), local_user());
- $itemUrl = (!empty($contactDetails['addr']) ? $contactDetails['addr'] : defaults($profile, 'profile_url', ''));
+ $profile_url = $profile['profile_url'] ?? '';
+ $contactDetails = Contact::getByURLForUser($profile_url, local_user());
$result = new ContactResult(
- defaults($profile, 'name', ''),
- defaults($profile, 'addr', ''),
- $itemUrl,
- defaults($profile, 'profile_url', ''),
- defaults($profile, 'photo', ''),
+ $profile['name'] ?? '',
+ $profile['addr'] ?? '',
+ ($contactDetails['addr'] ?? '') ?: $profile_url,
+ $profile_url,
+ $profile['photo'] ?? '',
Protocol::DFRN,
- defaults($contactDetails, 'cid', 0),
+ $contactDetails['cid'] ?? 0,
0,
- defaults($profile, 'tags', ''));
+ $profile['tags'] ?? ''
+ );
$resultList->addResult($result);
}
* Search in the local database for occurrences of the search string
*
* @param string $search
+ * @param int $type
* @param int $start
* @param int $itemPage
- * @param bool $community
*
- * @return ResultList|null
+ * @return ResultList
* @throws HTTPException\InternalServerErrorException
*/
- public static function getContactsFromLocalDirectory($search, $start = 0, $itemPage = 80, $community = false)
+ public static function getContactsFromLocalDirectory($search, $type = self::TYPE_ALL, $start = 0, $itemPage = 80)
{
- $config = self::getApp()->getConfig();
-
- $diaspora = $config->get('system', 'diaspora_enabled') ? Protocol::DIASPORA : Protocol::DFRN;
- $ostatus = !$config->get('system', 'ostatus_disabled') ? Protocol::OSTATUS : Protocol::DFRN;
-
- $wildcard = Strings::escapeHtml('%' . $search . '%');
-
- $count = DBA::count('gcontact', [
- 'NOT `hide`
- AND `network` IN (?, ?, ?, ?)
- AND ((`last_contact` >= `last_failure`) OR (`updated` >= `last_failure`))
- AND (`url` LIKE ? OR `name` LIKE ? OR `location` LIKE ?
- OR `addr` LIKE ? OR `about` LIKE ? OR `keywords` LIKE ?)
- AND `community` = ?',
- Protocol::ACTIVITYPUB, Protocol::DFRN, $ostatus, $diaspora,
- $wildcard, $wildcard, $wildcard,
- $wildcard, $wildcard, $wildcard,
- $community,
- ]);
-
- if (empty($count)) {
- return null;
- }
-
- $data = DBA::select('gcontact', ['nurl'], [
- 'NOT `hide`
- AND `network` IN (?, ?, ?, ?)
- AND ((`last_contact` >= `last_failure`) OR (`updated` >= `last_failure`))
- AND (`url` LIKE ? OR `name` LIKE ? OR `location` LIKE ?
- OR `addr` LIKE ? OR `about` LIKE ? OR `keywords` LIKE ?)
- AND `community` = ?',
- Protocol::ACTIVITYPUB, Protocol::DFRN, $ostatus, $diaspora,
- $wildcard, $wildcard, $wildcard,
- $wildcard, $wildcard, $wildcard,
- $community,
- ], [
- 'group_by' => ['nurl', 'updated'],
- 'limit' => [$start, $itemPage],
- 'order' => ['updated' => 'DESC']
- ]);
-
- if (!DBA::isResult($data)) {
- return null;
- }
-
- $resultList = new ResultList($start, $itemPage, $count);
-
- while ($row = DBA::fetch($data)) {
- if (PortableContact::alternateOStatusUrl($row["nurl"])) {
- continue;
- }
-
- $urlParts = parse_url($row["nurl"]);
+ Logger::info('Searching', ['search' => $search, 'type' => $type, 'start' => $start, 'itempage' => $itemPage]);
- // Ignore results that look strange.
- // For historic reasons the gcontact table does contain some garbage.
- if (!empty($urlParts['query']) || !empty($urlParts['fragment'])) {
- continue;
- }
+ $contacts = Contact::searchByName($search, $type == self::TYPE_FORUM ? 'community' : '');
- $contact = Contact::getDetailsByURL($row["nurl"], local_user());
-
- if ($contact["name"] == "") {
- $contact["name"] = end(explode("/", $urlParts["path"]));
- }
+ $resultList = new ResultList($start, $itemPage, count($contacts));
+ foreach ($contacts as $contact) {
$result = new ContactResult(
$contact["name"],
$contact["addr"],
$contact["url"],
$contact["photo"],
$contact["network"],
- $contact["cid"],
- $contact["zid"],
+ $contact["cid"] ?? 0,
+ $contact["zid"] ?? 0,
$contact["keywords"]
);
$resultList->addResult($result);
}
- DBA::close($data);
-
// Add found profiles from the global directory to the local directory
- Worker::add(PRIORITY_LOW, 'DiscoverPoCo', "dirsearch", urlencode($search));
+ Worker::add(PRIORITY_LOW, 'SearchDirectory', $search);
return $resultList;
}
+
+ /**
+ * Searching for contacts for autocompletion
+ *
+ * @param string $search Name or part of a name or nick
+ * @param string $mode Search mode (e.g. "community")
+ * @param int $page Page number (starts at 1)
+ * @return array with the search results
+ * @throws HTTPException\InternalServerErrorException
+ */
+ public static function searchContact($search, $mode, int $page = 1)
+ {
+ Logger::info('Searching', ['search' => $search, 'mode' => $mode, 'page' => $page]);
+
+ if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) {
+ return [];
+ }
+
+ // don't search if search term has less than 2 characters
+ if (!$search || mb_strlen($search) < 2) {
+ return [];
+ }
+
+ if (substr($search, 0, 1) === '@') {
+ $search = substr($search, 1);
+ }
+
+ // check if searching in the local global contact table is enabled
+ if (DI::config()->get('system', 'poco_local_search')) {
+ $return = Contact::searchByName($search, $mode);
+ } else {
+ $p = $page > 1 ? 'p=' . $page : '';
+ $curlResult = DI::httpClient()->get(self::getGlobalDirectory() . '/search/people?' . $p . '&q=' . urlencode($search), HttpClientAccept::JSON);
+ if ($curlResult->isSuccess()) {
+ $searchResult = json_decode($curlResult->getBody(), true);
+ if (!empty($searchResult['profiles'])) {
+ $return = $searchResult['profiles'];
+ }
+ }
+ }
+
+ return $return ?? [];
+ }
+
+ /**
+ * Returns the global directory name, used in this node
+ *
+ * @return string
+ */
+ public static function getGlobalDirectory()
+ {
+ return DI::config()->get('system', 'directory', self::DEFAULT_DIRECTORY);
+ }
+
+ /**
+ * Return the search path (either fulltext search or tag search)
+ *
+ * @param string $search
+ * @return string search path
+ */
+ public static function getSearchPath(string $search)
+ {
+ if (substr($search, 0, 1) == '#') {
+ return 'search?tag=' . urlencode(substr($search, 1));
+ } else {
+ return 'search?q=' . urlencode($search);
+ }
+ }
}
projects / friendica.git / blobdiff