mirror of
https://github.com/friendica/friendica
synced 2025-04-30 02:24:23 +02:00
330 lines
9.8 KiB
PHP
330 lines
9.8 KiB
PHP
<?php
|
|
|
|
// Copyright (C) 2010-2024, the Friendica project
|
|
// SPDX-FileCopyrightText: 2010-2024 the Friendica project
|
|
//
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
namespace Friendica\Util;
|
|
|
|
use Friendica\Core\Cache\Enum\Duration;
|
|
use Exception;
|
|
use Friendica\Core\System;
|
|
use Friendica\DI;
|
|
use Friendica\Protocol\ActivityPub;
|
|
use stdClass;
|
|
|
|
/**
|
|
* This class contain methods to work with JsonLD data
|
|
*/
|
|
class JsonLD
|
|
{
|
|
/**
|
|
* Loader for LD-JSON validation
|
|
*
|
|
* @param $url
|
|
*
|
|
* @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/security/data-integrity/v1':
|
|
$url = DI::basePath() . '/static/security-data-integrity-v1.jsonld';
|
|
break;
|
|
case 'https://w3id.org/security/multikey/v1':
|
|
$url = DI::basePath() . '/static/security-multikey-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://www.w3.org/ns/did/v1':
|
|
$url = DI::basePath() . '/static/did-v1.jsonld';
|
|
break;
|
|
case 'https://funkwhale.audio/ns':
|
|
$url = DI::basePath() . '/static/funkwhale.audio.jsonld';
|
|
break;
|
|
case 'http://schema.org':
|
|
$url = DI::basePath() . '/static/schema.jsonld';
|
|
break;
|
|
case 'http://joinmastodon.org/ns':
|
|
$url = DI::basePath() . '/static/joinmastodon.jsonld';
|
|
break;
|
|
case 'https://purl.archive.org/socialweb/webfinger':
|
|
$url = DI::basePath() . '/static/socialweb-webfinger.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:
|
|
DI::logger()->info('Got url', ['url' => $url]);
|
|
break;
|
|
}
|
|
}
|
|
|
|
$recursion = 0;
|
|
|
|
$x = debug_backtrace();
|
|
if ($x) {
|
|
foreach ($x as $n) {
|
|
if ($n['function'] === __FUNCTION__) {
|
|
$recursion++;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($recursion > 5) {
|
|
DI::logger()->error('jsonld bomb detected at: ' . $url);
|
|
System::exit();
|
|
}
|
|
|
|
$result = DI::cache()->get('documentLoader:' . $url);
|
|
if (!is_null($result)) {
|
|
return $result;
|
|
}
|
|
|
|
$data = jsonld_default_document_loader($url);
|
|
DI::cache()->set('documentLoader:' . $url, $data, Duration::DAY);
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Normalises a given JSON array
|
|
*
|
|
* @param array $json
|
|
*
|
|
* @return mixed|bool normalized JSON string
|
|
* @throws Exception
|
|
*/
|
|
public static function normalize($json)
|
|
{
|
|
jsonld_set_document_loader('Friendica\Util\JsonLD::documentLoader');
|
|
|
|
$jsonobj = json_decode(json_encode($json, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
|
|
|
|
try {
|
|
$normalized = jsonld_normalize($jsonobj, array('algorithm' => 'URDNA2015', 'format' => 'application/nquads'));
|
|
} catch (Exception $e) {
|
|
$normalized = false;
|
|
$messages = [];
|
|
$currentException = $e;
|
|
do {
|
|
$messages[] = $currentException->getMessage();
|
|
} while ($currentException = $currentException->getPrevious());
|
|
|
|
DI::logger()->notice('JsonLD normalize error', ['messages' => $messages]);
|
|
DI::logger()->info('JsonLD normalize error', ['trace' => $e->getTraceAsString()]);
|
|
DI::logger()->debug('JsonLD normalize error', ['jsonobj' => $jsonobj]);
|
|
}
|
|
|
|
return $normalized;
|
|
}
|
|
|
|
/**
|
|
* Compacts a given JSON array
|
|
*
|
|
* @param array $json
|
|
* @param bool $logfailed
|
|
*
|
|
* @return array Compacted JSON array
|
|
* @throws Exception
|
|
*/
|
|
public static function compact($json, bool $logfailed = true): array
|
|
{
|
|
jsonld_set_document_loader('Friendica\Util\JsonLD::documentLoader');
|
|
|
|
$context = (object)[
|
|
'as' => 'https://www.w3.org/ns/activitystreams#',
|
|
'w3id' => 'https://w3id.org/security#',
|
|
'ldp' => (object)['@id' => 'http://www.w3.org/ns/ldp#', '@type' => '@id'],
|
|
'vcard' => (object)['@id' => 'http://www.w3.org/2006/vcard/ns#', '@type' => '@id'],
|
|
'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'],
|
|
'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'],
|
|
'pixelfed' => (object)['@id' => 'http://pixelfed.org/ns#', '@type' => '@id'],
|
|
'lemmy' => (object)['@id' => 'https://join-lemmy.org/ns#', '@type' => '@id'],
|
|
];
|
|
|
|
$orig_json = $json;
|
|
|
|
$jsonobj = self::fixInvalidJsonLD($json);
|
|
|
|
try {
|
|
$compacted = jsonld_compact($jsonobj, $context);
|
|
} catch (Exception $e) {
|
|
$compacted = false;
|
|
DI::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, 'msg' => $e->getMessage(), 'previous' => $e->getPrevious()], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT));
|
|
DI::logger()->notice('Failed message stored', ['file' => $tempfile]);
|
|
}
|
|
}
|
|
|
|
$json = json_decode(json_encode($compacted, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), true);
|
|
|
|
if ($json === false) {
|
|
DI::logger()->notice('JSON encode->decode failed', ['orig_json' => $orig_json, 'compacted' => $compacted]);
|
|
$json = [];
|
|
}
|
|
|
|
return $json;
|
|
}
|
|
|
|
private static function fixInvalidJsonLD(array $json): stdClass
|
|
{
|
|
if (empty($json['@context'])) {
|
|
$json['@context'] = ActivityPub::CONTEXT;
|
|
}
|
|
|
|
// 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'])) {
|
|
DI::logger()->debug('Missing security context');
|
|
$json['@context'][] = 'https://w3id.org/security/v1';
|
|
}
|
|
}
|
|
|
|
// Issue 14448: Peertube transmits an unexpected type and schema URL.
|
|
array_walk_recursive($json['@context'], function (&$value, $key) {
|
|
if ($key == '@type' && $value == '@json') {
|
|
DI::logger()->debug('"@json" converted to "@id"');
|
|
$value = '@id';
|
|
}
|
|
if ($key == 'sc' && $value == 'http://schema.org/') {
|
|
DI::logger()->debug('schema.org path fixed');
|
|
$value = 'http://schema.org#';
|
|
}
|
|
// Issue 14630: Wordpress Event Bridge uses a URL that cannot be retrieved
|
|
if (is_int($key) && $value == 'https://schema.org/') {
|
|
DI::logger()->debug('https schema.org path fixed');
|
|
$value = 'https://schema.org/docs/jsonldcontext.json#';
|
|
}
|
|
});
|
|
|
|
// Bookwyrm transmits "id" fields with "null", which isn't allowed.
|
|
array_walk_recursive($json, function (&$value, $key) {
|
|
if ($key == 'id' && is_null($value)) {
|
|
DI::logger()->debug('Fixed null id');
|
|
$value = '';
|
|
}
|
|
});
|
|
|
|
return json_decode(json_encode($json, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
|
|
}
|
|
/**
|
|
* Fetches an element array from a JSON array
|
|
*
|
|
* @param $array
|
|
* @param $element
|
|
* @param $key
|
|
*
|
|
* @return array fetched element
|
|
*/
|
|
public static function fetchElementArray($array, $element, $key = null, $type = null, $type_value = null)
|
|
{
|
|
if (!isset($array[$element])) {
|
|
return null;
|
|
}
|
|
|
|
// If it isn't an array yet, make it to one
|
|
if (!is_array($array[$element]) || !is_int(key($array[$element]))) {
|
|
$array[$element] = [$array[$element]];
|
|
}
|
|
|
|
$elements = [];
|
|
|
|
foreach ($array[$element] as $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;
|
|
}
|
|
}
|
|
|
|
return $elements;
|
|
}
|
|
|
|
/**
|
|
* Fetches an element from a JSON array
|
|
*
|
|
* @param $array
|
|
* @param $element
|
|
* @param $key
|
|
* @param $type
|
|
* @param $type_value
|
|
*
|
|
* @return string|null fetched element
|
|
*/
|
|
public static function fetchElement($array, $element, $key = '@id', $type = null, $type_value = null)
|
|
{
|
|
if (empty($array)) {
|
|
return null;
|
|
}
|
|
|
|
if (!isset($array[$element])) {
|
|
return null;
|
|
}
|
|
|
|
if (!is_array($array[$element])) {
|
|
return $array[$element];
|
|
}
|
|
|
|
if (is_null($type) || is_null($type_value)) {
|
|
$element_array = self::fetchElementArray($array, $element, $key);
|
|
if (is_null($element_array)) {
|
|
return null;
|
|
}
|
|
|
|
return array_shift($element_array);
|
|
}
|
|
|
|
$element_array = self::fetchElementArray($array, $element);
|
|
if (is_null($element_array)) {
|
|
return null;
|
|
}
|
|
|
|
foreach ($element_array as $entry) {
|
|
if (isset($entry[$key]) && isset($entry[$type]) && ($entry[$type] == $type_value)) {
|
|
return $entry[$key];
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
}
|