]> git.mxchange.org Git - friendica.git/blobdiff - src/Util/JsonLD.php
Merge pull request #9345 from annando/issue-9344
[friendica.git] / src / Util / JsonLD.php
index 78d81816e25b1747c0f749e9488470bdcdfb6727..2649e9073788147ef6e7117d1982892b501fbf53 100644 (file)
@@ -1,24 +1,43 @@
 <?php
 /**
- * @file src/Util/JsonLD.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @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\Util;
 
-use Friendica\Core\Cache;
+use Friendica\Core\Cache\Duration;
 use Friendica\Core\Logger;
 use Exception;
+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)
        {
@@ -34,26 +53,27 @@ class JsonLD
                }
 
                if ($recursion > 5) {
-                       Logger::log('jsonld bomb detected at: ' . $url);
+                       Logger::error('jsonld bomb detected at: ' . $url);
                        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,18 +86,28 @@ 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
         *
-        * @return comacted JSON array
+        * @return array Compacted JSON array
+        * @throws Exception
         */
        public static function compact($json)
        {
@@ -91,37 +121,60 @@ class JsonLD
                        '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']];
+                       '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']];
 
-               $jsonobj = json_decode(json_encode($json, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
+               // Preparation for adding possibly missing content to the context
+               if (!empty($json['@context']) && is_string($json['@context'])) {
+                       $json['@context'] = [$json['@context']];
+               }
 
+               // Workaround for servers with missing context
+               // See issue https://github.com/nextcloud/social/issues/330
+               if (!empty($json['@context']) && is_array($json['@context'])) {
+                       $json['@context'][] = 'https://w3id.org/security/v1';
+               }
+
+               // Trying to avoid memory problems with large content fields
+               if (!empty($json['object']['source']['content'])) {
+                       $content = $json['object']['source']['content'];
+                       $json['object']['source']['content'] = '';
+               }
+
+               $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::error('compacting error');
+                       // Sooner or later we should log some details as well - but currently this leads to memory issues
+                       // Logger::log('compacting error:' . substr(print_r($e, true), 0, 10000), Logger::DEBUG);
                }
 
-               return json_decode(json_encode($compacted, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), true);
+               $json = json_decode(json_encode($compacted, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE), true);
+
+               if (isset($json['as:object']['as:source']['as:content']) && !empty($content)) {
+                       $json['as:object']['as:source']['as:content'] = $content;
+               }
+
+               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)
        {
-               if (empty($array)) {
-                       return null;
-               }
-
                if (!isset($array[$element])) {
                        return null;
                }
@@ -134,12 +187,10 @@ class JsonLD
                $elements = [];
 
                foreach ($array[$element] as $entry) {
-                       if (!is_array($entry)) {
+                       if (!is_array($entry) || (is_null($key) && is_array($entry))) {
                                $elements[] = $entry;
-                       } elseif (!empty($entry[$key])) {
+                       } elseif (!is_null($key) && isset($entry[$key])) {
                                $elements[] = $entry[$key];
-                       } elseif (!empty($entry) || !is_array($entry)) {
-                               $elements[] = $entry;
                        }
                }
 
@@ -147,7 +198,7 @@ class JsonLD
        }
 
        /**
-        * @brief Fetches an element from a JSON array
+        * Fetches an element from a JSON array
         *
         * @param $array
         * @param $element
@@ -155,7 +206,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)
        {