<?php
/**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
const DETECT_UNSPECIFIC = [self::DETECT_MANUAL, self::DETECT_HEADER, self::DETECT_BODY, self::DETECT_HOST_META, self::DETECT_CONTACTS, self::DETECT_AP_ACTOR];
// Implementation specific endpoints
+ // @todo Possibly add Lemmy detection via the endpoint /api/v3/site
const DETECT_FRIENDIKA = 10;
const DETECT_FRIENDICA = 11;
const DETECT_STATUSNET = 12;
*
* @param string $url
* @param boolean $only_nodeinfo
+ *
* @return void
*/
public static function add(string $url, bool $only_nodeinfo = false)
return;
}
- Worker::add(PRIORITY_LOW, 'UpdateGServer', $url, $only_nodeinfo);
+ Worker::add(Worker::PRIORITY_LOW, 'UpdateGServer', $url, $only_nodeinfo);
}
/**
*
* @param string $url
* @param boolean $no_check Don't check if the server hadn't been found
+ *
* @return int|null gserver id or NULL on empty URL or failed check
*/
- public static function getID(string $url, bool $no_check = false)
+ public static function getID(string $url, bool $no_check = false): ?int
{
+ $url = self::cleanURL($url);
+
if (empty($url)) {
return null;
}
- $url = self::cleanURL($url);
-
$gserver = DBA::selectFirst('gserver', ['id'], ['nurl' => Strings::normaliseLink($url)]);
if (DBA::isResult($gserver)) {
Logger::debug('Got ID for URL', ['id' => $gserver['id'], 'url' => $url, 'callstack' => System::callstack(20)]);
* The pattern is a simple fnmatch() pattern with ? for single wildcard and * for multiple wildcard
*
* @param string $pattern
+ *
* @return array
+ *
* @throws Exception
*/
public static function listByDomainPattern(string $pattern): array
}
/**
- * Checks if the given server is reachable
+ * Checks if the given server array is unreachable for a long time now
*
- * @param string $profile URL of the given profile
- * @param string $server URL of the given server (If empty, taken from profile)
- * @param string $network Network value that is used, when detection failed
- * @param boolean $force Force an update.
+ * @param integer $gsid
+ * @return boolean
+ */
+ private static function isDefunct(array $gserver): bool
+ {
+ return ($gserver['failed'] || in_array($gserver['network'], Protocol::FEDERATED)) &&
+ ($gserver['last_contact'] >= $gserver['created']) &&
+ ($gserver['last_contact'] < $gserver['last_failure']) &&
+ ($gserver['last_contact'] < DateTimeFormat::utc('now - 90 days'));
+ }
+
+ /**
+ * Checks if the given server id is unreachable for a long time now
*
- * @return boolean 'true' if server seems vital
+ * @param integer $gsid
+ * @return boolean
*/
- public static function reachable(string $profile, string $server = '', string $network = '', bool $force = false): bool
+ public static function isDefunctById(int $gsid): bool
{
- if ($server == '') {
- $contact = Contact::getByURL($profile, null, ['baseurl']);
- if (!empty($contact['baseurl'])) {
- $server = $contact['baseurl'];
+ $gserver = DBA::selectFirst('gserver', ['url', 'next_contact', 'last_contact', 'last_failure', 'created', 'failed', 'network'], ['id' => $gsid]);
+ if (empty($gserver)) {
+ return false;
+ } else {
+ if (strtotime($gserver['next_contact']) < time()) {
+ Worker::add(Worker::PRIORITY_LOW, 'UpdateGServer', $gserver['url'], false);
}
+ return self::isDefunct($gserver);
}
+ }
- if ($server == '') {
+ /**
+ * Checks if the given server id is reachable
+ *
+ * @param integer $gsid
+ * @return boolean
+ */
+ public static function isReachableById(int $gsid): bool
+ {
+ $gserver = DBA::selectFirst('gserver', ['url', 'next_contact', 'failed', 'network'], ['id' => $gsid]);
+ if (empty($gserver)) {
return true;
+ } else {
+ if (strtotime($gserver['next_contact']) < time()) {
+ Worker::add(Worker::PRIORITY_LOW, 'UpdateGServer', $gserver['url'], false);
+ }
+ return !$gserver['failed'] && in_array($gserver['network'], Protocol::FEDERATED);
}
+ }
- return self::check($server, $network, $force);
+ /**
+ * Checks if the given server is reachable
+ *
+ * @param array $contact Contact that should be checked
+ *
+ * @return boolean 'true' if server seems vital
+ */
+ public static function reachable(array $contact): bool
+ {
+ if (!empty($contact['gsid'])) {
+ $gsid = $contact['gsid'];
+ } elseif (!empty($contact['baseurl'])) {
+ $server = $contact['baseurl'];
+ } elseif ($contact['network'] == Protocol::DIASPORA) {
+ $parts = parse_url($contact['url']);
+ unset($parts['path']);
+ $server = (string)Uri::fromParts($parts);
+ } else {
+ return true;
+ }
+
+ if (!empty($gsid)) {
+ $condition = ['id' => $gsid];
+ } else {
+ $condition = ['nurl' => Strings::normaliseLink($server)];
+ }
+
+ $gserver = DBA::selectFirst('gserver', ['url', 'next_contact', 'failed', 'network'], $condition);
+ if (empty($gserver)) {
+ $reachable = true;
+ } else {
+ $reachable = !$gserver['failed'] && in_array($gserver['network'], Protocol::FEDERATED);
+ $server = $gserver['url'];
+ }
+
+ if (!empty($server) && (empty($gserver) || strtotime($gserver['next_contact']) < time())) {
+ Worker::add(Worker::PRIORITY_LOW, 'UpdateGServer', $server, false);
+ }
+
+ return $reachable;
}
- public static function getNextUpdateDate(bool $success, string $created = '', string $last_contact = '', bool $undetected = false)
+ /**
+ * Calculate the next update day
+ *
+ * @param bool $success
+ * @param string $created
+ * @param string $last_contact
+ * @param bool $undetected
+ *
+ * @return string
+ *
+ * @throws Exception
+ */
+ public static function getNextUpdateDate(bool $success, string $created = '', string $last_contact = '', bool $undetected = false): string
{
// On successful contact process check again next week when it is a detected system.
// When we haven't detected the system, it could be a static website or a really old system.
return self::detect($server_url, $network, $only_nodeinfo);
}
+ /**
+ * Reset failed server status by gserver id
+ *
+ * @param int $gsid
+ * @param string $network
+ */
+ public static function setReachableById(int $gsid, string $network)
+ {
+ $gserver = DBA::selectFirst('gserver', ['url', 'failed', 'next_contact', 'network'], ['id' => $gsid]);
+ if (DBA::isResult($gserver) && $gserver['failed']) {
+ $fields = ['failed' => false, 'last_contact' => DateTimeFormat::utcNow()];
+ if (!empty($network) && !in_array($gserver['network'], Protocol::FEDERATED)) {
+ $fields['network'] = $network;
+ }
+ self::update($fields, ['id' => $gsid]);
+ Logger::info('Reset failed status for server', ['url' => $gserver['url']]);
+
+ if (strtotime($gserver['next_contact']) < time()) {
+ Worker::add(Worker::PRIORITY_LOW, 'UpdateGServer', $gserver['url'], false);
+ }
+ }
+ }
+
+ /**
+ * Set failed server status by gserver id
+ *
+ * @param int $gsid
+ */
+ public static function setFailureById(int $gsid)
+ {
+ $gserver = DBA::selectFirst('gserver', ['url', 'failed', 'next_contact'], ['id' => $gsid]);
+ if (DBA::isResult($gserver) && !$gserver['failed']) {
+ self::update(['failed' => true, 'last_failure' => DateTimeFormat::utcNow()], ['id' => $gsid]);
+ Logger::info('Set failed status for server', ['url' => $gserver['url']]);
+
+ if (strtotime($gserver['next_contact']) < time()) {
+ Worker::add(Worker::PRIORITY_LOW, 'UpdateGServer', $gserver['url'], false);
+ }
+ }
+ }
+
/**
* Set failed server status
*
* @param string $url
*/
- public static function setFailure(string $url)
+ public static function setFailureByUrl(string $url)
{
$gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($url)]);
if (DBA::isResult($gserver)) {
'next_contact' => $next_update, 'network' => Protocol::PHANTOM, 'detection-method' => null],
['nurl' => Strings::normaliseLink($url)]);
Logger::info('Set failed status for existing server', ['url' => $url]);
+ if (self::isDefunct($gserver)) {
+ self::archiveContacts($gserver['id']);
+ }
return;
}
- DBA::insert('gserver', ['url' => $url, 'nurl' => Strings::normaliseLink($url),
+ self::insert(['url' => $url, 'nurl' => Strings::normaliseLink($url),
'network' => Protocol::PHANTOM, 'created' => DateTimeFormat::utcNow(),
'failed' => true, 'last_failure' => DateTimeFormat::utcNow()]);
Logger::info('Set failed status for new server', ['url' => $url]);
}
+ /**
+ * Archive server related contacts and inboxes
+ *
+ * @param integer $gsid
+ * @return void
+ */
+ private static function archiveContacts(int $gsid)
+ {
+ Contact::update(['archive' => true], ['gsid' => $gsid]);
+ DBA::update('inbox-status', ['archive' => true], ['gsid' => $gsid]);
+ }
+
/**
* Remove unwanted content from the given URL
*
- * @param string $url
+ * @param string $dirtyUrl
+ *
* @return string cleaned URL
+ * @throws Exception
*/
- public static function cleanURL(string $url): string
+ public static function cleanURL(string $dirtyUrl): string
{
- $url = trim($url, '/');
- $url = str_replace('/index.php', '', $url);
-
- $urlparts = parse_url($url);
- unset($urlparts['user']);
- unset($urlparts['pass']);
- unset($urlparts['query']);
- unset($urlparts['fragment']);
- return (string)Uri::fromParts($urlparts);
+ try {
+ $url = str_replace('/index.php', '', trim($dirtyUrl, '/'));
+ return (string)(new Uri($url))->withUserInfo('')->withQuery('')->withFragment('');
+ } catch (\Throwable $e) {
+ Logger::warning('Invalid URL', ['dirtyUrl' => $dirtyUrl, 'url' => $url]);
+ return '';
+ }
}
/**
// If the URL missmatches, then we mark the old entry as failure
if (!Strings::compareLink($url, $original_url)) {
- self::setFailure($original_url);
+ self::setFailureByUrl($original_url);
if (!self::getID($url, true)) {
self::detect($url, $network, $only_nodeinfo);
}
$valid_url = Network::isUrlValid($url);
if (!$valid_url) {
- self::setFailure($url);
+ self::setFailureByUrl($url);
return false;
} else {
$valid_url = rtrim($valid_url, '/');
if (((parse_url($url, PHP_URL_HOST) != parse_url($valid_url, PHP_URL_HOST)) && (parse_url($url, PHP_URL_PATH) == parse_url($valid_url, PHP_URL_PATH))) ||
(((parse_url($url, PHP_URL_HOST) != parse_url($valid_url, PHP_URL_HOST)) || (parse_url($url, PHP_URL_PATH) != parse_url($valid_url, PHP_URL_PATH))) && empty(parse_url($valid_url, PHP_URL_PATH)))) {
Logger::debug('Found redirect. Mark old entry as failure', ['old' => $url, 'new' => $valid_url]);
- self::setFailure($url);
+ self::setFailureByUrl($url);
if (!self::getID($valid_url, true)) {
self::detect($valid_url, $network, $only_nodeinfo);
}
unset($parts['path']);
$valid_url = (string)Uri::fromParts($parts);
- self::setFailure($url);
+ self::setFailureByUrl($url);
if (!self::getID($valid_url, true)) {
self::detect($valid_url, $network, $only_nodeinfo);
}
- return false;
+ return false;
}
Logger::debug('Found redirect, but ignore it.', ['old' => $url, 'new' => $valid_url]);
}
// When a nodeinfo is present, we don't need to dig further
$curlResult = DI::httpClient()->get($url . '/.well-known/x-nodeinfo2', HttpClientAccept::JSON);
if ($curlResult->isTimeout()) {
- self::setFailure($url);
+ self::setFailureByUrl($url);
return false;
}
if ($only_nodeinfo && empty($serverdata)) {
Logger::info('Invalid nodeinfo in nodeinfo-mode, server is marked as failure', ['url' => $url]);
- self::setFailure($url);
+ self::setFailureByUrl($url);
return false;
} elseif (empty($serverdata)) {
$serverdata = ['detection-method' => self::DETECT_MANUAL, 'network' => Protocol::PHANTOM, 'platform' => '', 'version' => '', 'site_name' => '', 'info' => ''];
}
if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
- self::setFailure($url);
+ self::setFailureByUrl($url);
return false;
}
// Most servers aren't installed in a subdirectory, so we declare this entry as failed
if (($serverdata['network'] == Protocol::PHANTOM) && !empty(parse_url($url, PHP_URL_PATH)) && in_array($serverdata['detection-method'], [self::DETECT_MANUAL])) {
- self::setFailure($url);
+ self::setFailureByUrl($url);
return false;
}
$serverdata = self::detectNetworkViaContacts($url, $serverdata);
}
+ if (($serverdata['network'] == Protocol::PHANTOM) && in_array($serverdata['detection-method'], [self::DETECT_MANUAL, self::DETECT_BODY])) {
+ self::setFailureByUrl($url);
+ return false;
+ }
+
// Detect the directory type
$serverdata['directory-type'] = self::DT_NONE;
$serverdata['registered-users'] = $serverdata['registered-users'] ?? 0;
+ // Numbers above a reasonable value (10 millions) are ignored
+ if ($serverdata['registered-users'] > 10000000) {
+ $serverdata['registered-users'] = 0;
+ }
+
// On an active server there has to be at least a single user
- if (!in_array($serverdata['network'], [Protocol::PHANTOM, Protocol::FEED]) && ($serverdata['registered-users'] == 0)) {
+ if (!in_array($serverdata['network'], [Protocol::PHANTOM, Protocol::FEED]) && ($serverdata['registered-users'] <= 0)) {
$serverdata['registered-users'] = 1;
} elseif (in_array($serverdata['network'], [Protocol::PHANTOM, Protocol::FEED])) {
$serverdata['registered-users'] = 0;
$gserver = DBA::selectFirst('gserver', ['network'], ['nurl' => Strings::normaliseLink($url)]);
if (!DBA::isResult($gserver)) {
$serverdata['created'] = DateTimeFormat::utcNow();
- $ret = DBA::insert('gserver', $serverdata);
+ $ret = self::insert($serverdata);
$id = DBA::lastInsertId();
} else {
$ret = self::update($serverdata, ['nurl' => $serverdata['nurl']]);
* Fetch relay data from a given server url
*
* @param string $server_url address of the server
+ *
* @return void
+ *
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
private static function discoverRelay(string $server_url)
* Fetch server data from '/statistics.json' on the given server
*
* @param string $url URL of the given server
+ *
* @return array server data
*/
- private static function fetchStatistics(string $url, array $serverdata)
+ private static function fetchStatistics(string $url, array $serverdata): array
{
$curlResult = DI::httpClient()->get($url . '/statistics.json', HttpClientAccept::JSON);
if (!$curlResult->isSuccess()) {
* @param ICanHandleHttpResponses $httpResult
*
* @return array Server data
+ *
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
private static function fetchNodeinfo(string $url, ICanHandleHttpResponses $httpResult): array
* Parses Nodeinfo 1
*
* @param string $nodeinfo_url address of the nodeinfo path
+ *
* @return array Server data
+ *
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
private static function parseNodeinfo1(string $nodeinfo_url): array
* Parses Nodeinfo 2
*
* @see https://git.feneas.org/jaywink/nodeinfo2
+ *
* @param string $nodeinfo_url address of the nodeinfo path
+ *
* @return array Server data
+ *
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
private static function parseNodeinfo2(string $nodeinfo_url): array
* Parses NodeInfo2 protocol 1.0
*
* @see https://github.com/jaywink/nodeinfo2/blob/master/PROTOCOL.md
+ *
* @param string $nodeinfo_url address of the nodeinfo path
+ *
* @return array Server data
+ *
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function parseNodeinfo210(ICanHandleHttpResponses $httpResult)
+ private static function parseNodeinfo210(ICanHandleHttpResponses $httpResult): array
{
if (!$httpResult->isSuccess()) {
return [];
*
* @param string $url URL of the given server
* @param array $serverdata array with server data
+ *
* @return array server data
*/
private static function fetchSiteinfo(string $url, array $serverdata): array
if (!empty($data['url'])) {
$serverdata['platform'] = strtolower($data['platform']);
- $serverdata['version'] = $data['version'];
+ $serverdata['version'] = $data['version'] ?? 'N/A';
}
if (!empty($data['plugins'])) {
return $serverdata;
}
- private static function fetchDataFromSystemActor(array $data, array $serverdata)
+ /**
+ * Fetches server data via an ActivityPub account with url of that server
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ *
+ * @throws Exception
+ */
+ private static function fetchDataFromSystemActor(array $data, array $serverdata): array
{
if (empty($data)) {
return ['server' => $serverdata, 'actor' => ''];
* Checks if the server contains a valid host meta file
*
* @param string $url URL of the given server
+ *
* @return boolean 'true' if the server seems to be vital
*/
private static function validHostMeta(string $url): bool
{
$xrd_timeout = DI::config()->get('system', 'xrd_timeout');
- $curlResult = DI::httpClient()->get($url . '/.well-known/host-meta', HttpClientAccept::XRD_XML, [HttpClientOptions::TIMEOUT => $xrd_timeout]);
+ $curlResult = DI::httpClient()->get($url . Probe::HOST_META, HttpClientAccept::XRD_XML, [HttpClientOptions::TIMEOUT => $xrd_timeout]);
if (!$curlResult->isSuccess()) {
return false;
}
- $xrd = XML::parseString($curlResult->getBody());
+ $xrd = XML::parseString($curlResult->getBody(), true);
if (!is_object($xrd)) {
return false;
}
*
* @param string $url URL of the given server
* @param array $serverdata array with server data
+ *
* @return array server data
*/
private static function detectNetworkViaContacts(string $url, array $serverdata): array
*
* @param string $url URL of the given server
* @param array $serverdata array with server data
+ *
* @return array server data
*/
private static function checkPoCo(string $url, array $serverdata): array
*
* @param string $url URL of the given server
* @param array $serverdata array with server data
+ *
* @return array server data
*/
public static function checkMastodonDirectory(string $url, array $serverdata): array
*
* @return array server data
*/
- private static function detectNextcloud(string $url, array $serverdata, bool $validHostMeta)
+ private static function detectNextcloud(string $url, array $serverdata, bool $validHostMeta): array
{
$curlResult = DI::httpClient()->get($url . '/status.php', HttpClientAccept::JSON);
if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
*
* @param string $url URL of the given server
* @param array $serverdata array with server data
+ *
* @return array server data
*/
private static function fetchWeeklyUsage(string $url, array $serverdata): array
*
* @param string $url URL of the given server
* @param array $serverdata array with server data
+ *
* @return array server data
*/
private static function detectMastodonAlikes(string $url, array $serverdata): array
*
* @param string $url URL of the given server
* @param array $serverdata array with server data
+ *
* @return array server data
*/
private static function detectHubzilla(string $url, array $serverdata): array
* Converts input value to a boolean value
*
* @param string|integer $val
+ *
* @return boolean
*/
private static function toBoolean($val): bool
*
* @param string $url URL of the given server
* @param array $serverdata array with server data
+ *
* @return array server data
*/
private static function detectGNUSocial(string $url, array $serverdata): array
*
* @param string $url URL of the given server
* @param array $serverdata array with server data
+ *
* @return array server data
*/
private static function detectFriendica(string $url, array $serverdata): array
*
* @return array server data
*/
- private static function analyseRootBody($curlResult, array $serverdata): array
+ private static function analyseRootBody($curlResult, array $serverdata): array
{
if (empty($curlResult->getBody())) {
return $serverdata;
}
- if (file_exists(__DIR__ . '/../../static/generator.config.php')) {
- require __DIR__ . '/../../static/generator.config.php';
+ if (file_exists(__DIR__ . '/../../static/platforms.config.php')) {
+ require __DIR__ . '/../../static/platforms.config.php';
} else {
- throw new HTTPException\InternalServerErrorException('Invalid generator file');
+ throw new HTTPException\InternalServerErrorException('Invalid platform file');
}
$platforms = array_merge($ap_platforms, $dfrn_platforms, $zap_platforms, $platforms);
while ($gserver = DBA::fetch($gservers)) {
Logger::info('Update peer list', ['server' => $gserver['url'], 'id' => $gserver['id']]);
- Worker::add(PRIORITY_LOW, 'UpdateServerPeers', $gserver['url']);
+ Worker::add(Worker::PRIORITY_LOW, 'UpdateServerPeers', $gserver['url']);
Logger::info('Update directory', ['server' => $gserver['url'], 'id' => $gserver['id']]);
- Worker::add(PRIORITY_LOW, 'UpdateServerDirectory', $gserver);
+ Worker::add(Worker::PRIORITY_LOW, 'UpdateServerDirectory', $gserver);
$fields = ['last_poco_query' => DateTimeFormat::utcNow()];
self::update($fields, ['nurl' => $gserver['nurl']]);
*/
private static function discoverFederation()
{
- $last = DI::config()->get('poco', 'last_federation_discovery');
+ $last = DI::keyValue()->get('poco_last_federation_discovery');
if ($last) {
$next = $last + (24 * 60 * 60);
if ($curlResult->isSuccess()) {
$servers = json_decode($curlResult->getBody(), true);
- foreach ($servers['instances'] as $server) {
- $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
- self::add($url);
+ if (!empty($servers['instances'])) {
+ foreach ($servers['instances'] as $server) {
+ $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
+ self::add($url);
+ }
}
}
}
- DI::config()->set('poco', 'last_federation_discovery', time());
+ DI::keyValue()->set('poco_last_federation_discovery', time());
}
/**
*
* @param int $gsid Server id
* @param int $protocol Protocol id
- * @return void
+ *
* @throws Exception
*/
public static function setProtocol(int $gsid, int $protocol)
* Fetch the protocol of the given server
*
* @param int $gsid Server id
+ *
* @return ?int One of Post\DeliveryData protocol constants or null if unknown or gserver is missing
+ *
* @throws Exception
*/
public static function getProtocol(int $gsid): ?int
}
/**
+ * Update rows in the gserver table.
* Enforces gserver table field maximum sizes to avoid "Data too long" database errors
*
* @param array $fields
* @param array $condition
+ *
* @return bool
+ *
* @throws Exception
*/
public static function update(array $fields, array $condition): bool
return DBA::update('gserver', $fields, $condition);
}
+
+ /**
+ * Insert a row into the gserver table.
+ * Enforces gserver table field maximum sizes to avoid "Data too long" database errors
+ *
+ * @param array $fields
+ * @param int $duplicate_mode What to do on a duplicated entry
+ *
+ * @return bool
+ *
+ * @throws Exception
+ */
+ public static function insert(array $fields, int $duplicate_mode = Database::INSERT_DEFAULT): bool
+ {
+ $fields = DI::dbaDefinition()->truncateFieldsForTable('gserver', $fields);
+
+ return DBA::insert('gserver', $fields, $duplicate_mode);
+ }
}
projects / friendica.git / blobdiff