X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FUtil%2FJsonLD.php;h=0a4d5a0b55bf40808e891f81a1d832e0377ca3c1;hb=9c86578755e62f16b972debf07a83c424b626446;hp=bed7a67d60a01eeccf58bc6a312f6f363541f4b6;hpb=1395bdc1881e8e8ecac3823f62648d250fcf7874;p=friendica.git diff --git a/src/Util/JsonLD.php b/src/Util/JsonLD.php index bed7a67d60..0a4d5a0b55 100644 --- a/src/Util/JsonLD.php +++ b/src/Util/JsonLD.php @@ -1,27 +1,76 @@ . + * */ + namespace Friendica\Util; -use Friendica\Core\Cache; +use Friendica\Core\Cache\Enum\Duration; use Friendica\Core\Logger; use Exception; +use Friendica\Core\System; +use Friendica\DI; /** - * @brief This class contain methods to work with JsonLD data + * This class contain methods to work with JsonLD data */ class JsonLD { /** - * @brief Loader for LD-JSON validation + * Loader for LD-JSON validation * * @param $url * - * @return the loaded data + * @return mixed the loaded data + * @throws \JsonLdException */ public static function documentLoader($url) { + switch ($url) { + case 'https://w3id.org/security/v1': + $url = DI::basePath() . '/static/security-v1.jsonld'; + break; + case 'https://w3id.org/identity/v1': + $url = DI::basePath() . '/static/identity-v1.jsonld'; + break; + case 'https://www.w3.org/ns/activitystreams': + $url = DI::basePath() . '/static/activitystreams.jsonld'; + break; + case 'https://funkwhale.audio/ns': + $url = DI::basePath() . '/static/funkwhale.audio.jsonld'; + break; + default: + switch (parse_url($url, PHP_URL_PATH)) { + case '/schemas/litepub-0.1.jsonld'; + $url = DI::basePath() . '/static/litepub-0.1.jsonld'; + break; + case '/apschema/v1.2': + case '/apschema/v1.9': + case '/apschema/v1.10': + $url = DI::basePath() . '/static/apschema.jsonld'; + break; + default: + Logger::info('Got url', ['url' =>$url]); + break; + } + } + $recursion = 0; $x = debug_backtrace(); @@ -34,26 +83,27 @@ class JsonLD } if ($recursion > 5) { - Logger::log('jsonld bomb detected at: ' . $url); - exit(); + Logger::error('jsonld bomb detected at: ' . $url); + System::exit(); } - $result = Cache::get('documentLoader:' . $url); + $result = DI::cache()->get('documentLoader:' . $url); if (!is_null($result)) { return $result; } $data = jsonld_default_document_loader($url); - Cache::set('documentLoader:' . $url, $data, Cache::DAY); + DI::cache()->set('documentLoader:' . $url, $data, Duration::DAY); return $data; } /** - * @brief Normalises a given JSON array + * Normalises a given JSON array * * @param array $json * - * @return normalized JSON string + * @return mixed|bool normalized JSON string + * @throws Exception */ public static function normalize($json) { @@ -66,20 +116,31 @@ class JsonLD } catch (Exception $e) { $normalized = false; - Logger::log('normalise error:' . print_r($e, true), Logger::DEBUG); + $messages = []; + $currentException = $e; + do { + $messages[] = $currentException->getMessage(); + } while($currentException = $currentException->getPrevious()); + + Logger::warning('JsonLD normalize error'); + Logger::notice('JsonLD normalize error', ['messages' => $messages]); + Logger::info('JsonLD normalize error', ['trace' => $e->getTraceAsString()]); + Logger::debug('JsonLD normalize error', ['jsonobj' => $jsonobj]); } return $normalized; } /** - * @brief Compacts a given JSON array + * Compacts a given JSON array * * @param array $json + * @param bool $logfailed * - * @return comacted JSON array + * @return array Compacted JSON array + * @throws Exception */ - public static function compact($json) + public static function compact($json, bool $logfailed = true): array { jsonld_set_document_loader('Friendica\Util\JsonLD::documentLoader'); @@ -90,55 +151,103 @@ class JsonLD 'dfrn' => (object)['@id' => 'http://purl.org/macgirvin/dfrn/1.0/', '@type' => '@id'], 'diaspora' => (object)['@id' => 'https://diasporafoundation.org/ns/', '@type' => '@id'], 'ostatus' => (object)['@id' => 'http://ostatus.org#', '@type' => '@id'], - 'dc' => (object)['@id' => 'http://purl.org/dc/terms/', '@type' => '@id']]; + 'dc' => (object)['@id' => 'http://purl.org/dc/terms/', '@type' => '@id'], + 'toot' => (object)['@id' => 'http://joinmastodon.org/ns#', '@type' => '@id'], + 'litepub' => (object)['@id' => 'http://litepub.social/ns#', '@type' => '@id'], + 'sc' => (object)['@id' => 'http://schema.org#', '@type' => '@id'], + 'pt' => (object)['@id' => 'https://joinpeertube.org/ns#', '@type' => '@id'], + 'mobilizon' => (object)['@id' => 'https://joinmobilizon.org/ns#', '@type' => '@id'], + 'fedibird' => (object)['@id' => 'http://fedibird.com/ns#', '@type' => '@id'], + 'misskey' => (object)['@id' => 'https://misskey-hub.net/ns#', '@type' => '@id'], + ]; - $jsonobj = json_decode(json_encode($json, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)); + $orig_json = $json; + + // Preparation for adding possibly missing content to the context + if (!empty($json['@context']) && is_string($json['@context'])) { + $json['@context'] = [$json['@context']]; + } + + if (!empty($json['@context']) && is_array($json['@context'])) { + // Remove empty entries from the context (a problem with WriteFreely) + $json['@context'] = array_filter($json['@context']); + // Workaround for servers with missing context + // See issue https://github.com/nextcloud/social/issues/330 + if (!in_array('https://w3id.org/security/v1', $json['@context'])) { + $json['@context'][] = 'https://w3id.org/security/v1'; + } + + // Issue 12419: Workaround for GoToSocial + $pos = array_search('http://joinmastodon.org/ns', $json['@context']); + if (is_int($pos)) { + $json['@context'][$pos] = ['toot' => 'http://joinmastodon.org/ns#']; + } + } + + // Bookwyrm transmits "id" fields with "null", which isn't allowed. + array_walk_recursive($json, function (&$value, $key) { + if ($key == 'id' && is_null($value)) { + $value = ''; + } + }); + + $jsonobj = json_decode(json_encode($json, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)); try { $compacted = jsonld_compact($jsonobj, $context); } catch (Exception $e) { $compacted = false; - Logger::log('compacting error:' . print_r($e, true), Logger::DEBUG); + Logger::notice('compacting error', ['msg' => $e->getMessage(), 'previous' => $e->getPrevious(), 'line' => $e->getLine()]); + if ($logfailed && DI::config()->get('debug', 'ap_log_failure')) { + $tempfile = tempnam(System::getTempPath(), 'failed-jsonld'); + file_put_contents($tempfile, json_encode(['json' => $orig_json, 'callstack' => System::callstack(20), 'msg' => $e->getMessage(), 'previous' => $e->getPrevious()], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT)); + Logger::notice('Failed message stored', ['file' => $tempfile]); + } + } + + $json = json_decode(json_encode($compacted, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), true); + + if ($json === false) { + Logger::notice('JSON encode->decode failed', ['orig_json' => $orig_json, 'compacted' => $compacted]); + $json = []; } - return json_decode(json_encode($compacted, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), true); + return $json; } /** - * @brief Fetches an element array from a JSON array + * Fetches an element array from a JSON array * * @param $array * @param $element * @param $key * - * @return fetched element array + * @return array fetched element */ - public static function fetchElementArray($array, $element, $key = '@id') + public static function fetchElementArray($array, $element, $key = null, $type = null, $type_value = null) { - if (empty($array)) { - return null; - } - if (!isset($array[$element])) { return null; } // If it isn't an array yet, make it to one - if (!is_int(key($array[$element]))) { + if (!is_array($array[$element]) || !is_int(key($array[$element]))) { $array[$element] = [$array[$element]]; } $elements = []; foreach ($array[$element] as $entry) { - if (!is_array($entry)) { - $elements[] = $entry; - } elseif (!empty($entry[$key])) { - $elements[] = $entry[$key]; - } elseif (!empty($entry) || !is_array($entry)) { - $elements[] = $entry; + if (!is_array($entry) || is_null($key)) { + $item = $entry; + } elseif (isset($entry[$key])) { + $item = $entry[$key]; + } + + if (isset($item) && (is_null($type) || is_null($type_value) || isset($item[$type]) && $item[$type] == $type_value)) { + $elements[] = $item; } } @@ -146,7 +255,7 @@ class JsonLD } /** - * @brief Fetches an element from a JSON array + * Fetches an element from a JSON array * * @param $array * @param $element @@ -154,7 +263,7 @@ class JsonLD * @param $type * @param $type_value * - * @return fetched element + * @return string fetched element */ public static function fetchElement($array, $element, $key = '@id', $type = null, $type_value = null) {